Align

An online teaching platform to get education for everyone!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

https://align.onrender.com/

A solo starter project to understand website development and full-stack engineers. A teaching platform, with the ability to sign up, log in, log out, create a course, join a course, view other people's profiles.

• User Requirements
  

• Website Architecture
  

  (back to top)

• ERD
  

• Landing Page (WIP)
  

• Sign Up Page
  

• Login Page
  

• Styling
  

• Dynamic
  

• Alerts
  

Built With

• Flask
• SQLalchemy
• Python
• Jinja
• Render.com - Web hosting
• HTML
• CSS
• Javascript

(back to top)

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Installing requirements

  pip install -r requirements.txt 

Installation

1. Clone the repo

   git clone https://github.com/Tsangington/Align.git

2. Create a config.py file outside of the app folder, and use a development config, or use these values:

   class Config(object):
     SECRET_KEY = 'DEV_TEST_KEY_:D_BASED123456789'
     DEBUG = False
     TESTING = False
     SQLALCHEMY_DATABASE_URI = 'sqlite:///database.db'
    
   class DevelopmentConfig(Config):
     DEBUG = True
     SQLALCHEMY_DATABASE_URI = 'sqlite:///development.db'
     DB_NAME = "development-db"
     DB_USERNAME = "development.db"

3. Create a virtual environment:

   #Windows
   python -m virtualenv <venvName>
   #Mac
   virtualenv <venvName>

4. Enter the virtual environment:

   #Windows
   <venvName>\Scripts\activate
   #Mac
   source <venvName>/bin/activate
   
   #To Leave the venv:
   deactivate

5. Install the pre-requesites

   pip install -r requirements.txt 

6. To run the localhost,

   py main.py

7. Secret URLs (Not yet implemented front-end)

   align/user/<username> #searches for a user
   align/logout #logs out the current user
   align/createcourse #create a course
   align/join #see and join all available courses
   align/delete #deletes the current user from the database

(back to top)

Roadmap

• Course Privacy
• Landing Page
• Better Security

(back to top)

Contact

[email protected]

Project Link: https://github.com/Tsangington/Align

(back to top)