LearnQuest - A Full Stack Learning Management System

LearnQuest is a full stack learning management system designed to make learning more fun and interacitve. A lot of learning management platforms are very dull such as Canvas which can make learning feel like a chore rather than exciting. Our application improves the learning experience through adding features such as progress bars, mini challenges, and a peer review functionality in order to help students stay motivated while providing them with the tools they need to succeed.

Technology Stack

• Backend: Flask
• Database: SQLAlchemy
• Forms: WTForms and Flask-WTF
• Frontend: HTML and CSS
• Version Control: Git and GitHub
• Development Environment: PyCharm

Setup and Run

Follow these steps to set up the project and run the Flask web application.

1. Clone the repository

Navigate to the folder where you want to store the project and run:

git clone https://github.com/addisionschleigh/CMPE131-Project.git
cd CMPE131-Project

2. Create a virtual environment

Create a Python virtual environment to keep dependencies isolated:

python3 -m venv .venv

3. Activate the virtual environment

• macOS or Linux:

  source .venv/bin/activate

• Windows(Command Prompt):

    .\.venv\Scripts\activate

  After activation, your terminal should show (.venv).

4. Install dependencies

Install all of the required packages from the requirements.txt:

pip install --upgrade pip
pip install -r requirements.txt

requirements.txt should include:

Flask==2.3.2
Flask-Login==0.6.3
Flask-WTF==1.1.1
Flask-SQLAlchemy==3.1.1
WTForms==3.1.2
SQLAlchemy==2.0.21
pytest==9.0.2
pytest-cov==7.0.0

5. Run the application

If your main app file is run.py:

python run.py

Alternatively, if you are using Flask's built-in runner:

export FLASK_APP=run.py   # macOS/Linux
$env:FLASK_APP="run.py"   # Windows PowerShell
set FLASK_APP=run.py      # Windows Command Prompt
flask run

• Open your browser and go to: http://127.0.0.1:5000
• The application should be running locally on your machine

Test Instructions

1. First, be sure to register (login page)
2. Log in, choose a role (ideal to start with instructor role)
3. Create course(s). These course(s) can also be deleted
4. Go to course(s)
5. Add assignments to course(s). These assignments can also be deleted
6. Back at the dashboard, assignments should be seen
7. Logout, then log back in as a student
8. You should see the assignments and be able to submit them
9. Submitted assignments should be seen on the dashboard and course page

PyTest Instructions

Simply need to put pytest in the terminal or run them individually in their respective files.

Milestone 1 Screenshots

Screenshot of rendered page (This is after Login POST):

Home Screen UI Sketch

Feature Page UI Sketch

Login Page UI Sketch

Dashboard UI Sketch

• Used Visily AI for the UI sketches but I drew them by hand first
• [(https://www.visily.ai/)]

Milestone 2 Screenshots

Screenshot of initial dashboard page

Screenshot of login page

Screenshot of dashboard with courses

Screenshot of course page

Screenshot of dashbaord with completed assignments

Meet Our Team

• Project Manager/UI Developer: Abdullah Ahmed
• Main Programmer: Addison Schleigh
• Software Engineer: Kenneth Lau