Study Scheduler

Description

The Study Scheduler is a web-based application designed to help users organize and track study sessions. The system enables users to create, join, and manage study groups with the ability to schedule sessions, edit sessions, and join sessions, all done with authentication. It is containerized for seamless deployment and includes a CI/CD pipeline for continuous integration and delivery.

DockerHub Container Images

• Study Scheduler

Setup Instructions

Prerequisites

• Docker and Docker Compose installed on your system.
• A MongoDB instance accessible with the appropriate connection string.
• Python 3.10 or higher installed (for local testing and development).

Steps to Run the Project

1. Clone the Repository

   git clone https://github.com/software-students-fall2024/5-final-nighthawks.git
   cd 5-final-nighthawks	

2. Set Up Environment Variables Create a .env file in the project root with the following content:

   # MongoDB Connection
   MONGO_URI=mongodb://mongo:27017/studySchedulerDB
   
   # Flask Configuration
   FLASK_ENV=development
   FLASK_APP=app.py
   
   # Application Secrets
   SECRET_KEY=<your_secret_key>
   
   # Application Port
   PORT=8000

3. Build and Run Containers Use Docker Compose to build and run the application:

docker-compose up --build

4. Access the Application Once the containers are running:

The app will be accessible at http://localhost:8000

5. Shut Down the Application To stop the application, run:

docker-compose down

Visit the App

TEAM MEMBERS

• Tahsin Tawhid
• James Whitten
• Jack Zhang
• Joseph Hwang