https://github.com/shz-code/routine_master
Python-based application designed to help manage and optimize faculty routines for the CSE department of IUBAT
https://github.com/shz-code/routine_master
fastapi react redux-toolkit sqlite tailwindcss
Last synced: 16 days ago
JSON representation
Python-based application designed to help manage and optimize faculty routines for the CSE department of IUBAT
- Host: GitHub
- URL: https://github.com/shz-code/routine_master
- Owner: shz-code
- Created: 2024-12-20T13:37:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-24T18:55:17.000Z (over 1 year ago)
- Last Synced: 2025-02-16T13:58:08.719Z (about 1 year ago)
- Topics: fastapi, react, redux-toolkit, sqlite, tailwindcss
- Language: JavaScript
- Homepage:
- Size: 294 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Routine Master
**Routine Master** is a Python-based application designed to help manage and optimize faculty routines for each semester. This project is specifically made for the `CSE department of IUBAT` to maintain and generate faculty routines efficiently.
## Features
- Create and manage faculty routines
- Track class schedules and availability
- Generate optimized routines for each semester
- User-friendly interface
- Frontend built with React, Redux, and Tailwind CSS for an interactive experience
- Backend powered by FastAPI for efficient performance
## Installation
1. Clone the repository:
```bash
git clone https://github.com/shz_code/routine_master.git
```
2. Navigate to the project directory:
```bash
cd routine_master
```
## Backend Setup
1. Navigate to the server directory:
```bash
cd server
```
2. Create and activate a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. Install the required dependencies:
```bash
pip install -r requirements.txt
```
4. Start server:
```bash
uvicorn src.main:app --reload
```
## Frontend Setup
1. Navigate to the client directory and install dependencies:
```bash
cd client
npm install
```
2. Create .env file that has the server api url (give the backend root url here):
```bash
cp .env.example .env
```
3. Start the frontend application:
```bash
npm run dev
```
4. Open your web browser and navigate to `http://localhost:5173` to access the frontend.
5. Follow the on-screen instructions to set up and manage faculty routines.
## Contact
For any questions or suggestions, please contact [web.shahidul.alam@gmail.com](mailto:web.shahidul.alam@gmail.com).