|
| 1 | +--- |
| 2 | +title: Grade Cutoff Squeezer |
| 3 | +description: Web application for approximating course grade cutoffs using crowdsourced data |
| 4 | +--- |
| 5 | + |
| 6 | +Website for approximating the grade cutoffs for courses by using user-submitted data. |
| 7 | + |
| 8 | +## Features |
| 9 | + |
| 10 | +- User authentication with JWT |
| 11 | +- Course grade submission system |
| 12 | +- Dynamic grade cutoff calculation |
| 13 | +- Search-enabled course selection |
| 14 | +- Rate limiting for submissions |
| 15 | +- Mobile-responsive design |
| 16 | +- Year-wise course tracking |
| 17 | + |
| 18 | +## Tech Stack |
| 19 | + |
| 20 | +### Frontend |
| 21 | +- React.js |
| 22 | +- Chakra UI |
| 23 | +- Vite |
| 24 | + |
| 25 | +### Backend |
| 26 | +- Python Flask |
| 27 | +- SQLAlchemy |
| 28 | +- JWT Authentication |
| 29 | + |
| 30 | +## Setup |
| 31 | + |
| 32 | +### Prerequisites |
| 33 | + |
| 34 | +- [Node.js](https://nodejs.org/en/) |
| 35 | +- [NPM](https://www.npmjs.com/) |
| 36 | +- [Python 3](https://www.python.org/downloads/) |
| 37 | + |
| 38 | +### Running |
| 39 | + |
| 40 | +1. Backend |
| 41 | + ```bash |
| 42 | + cd backend |
| 43 | + python3 -m venv venv |
| 44 | + source venv/bin/activate |
| 45 | + pip install -r requirements.txt |
| 46 | + python3 run.py |
| 47 | + ``` |
| 48 | +2. Frontend |
| 49 | + ```bash |
| 50 | + cd frontend |
| 51 | + npm install |
| 52 | + npx @chakra-ui/cli snippet add toaster |
| 53 | + npx @chakra-ui/cli snippet add field |
| 54 | + npx @chakra-ui/cli snippet add provider |
| 55 | + npx @chakra-ui/cli snippet add select |
| 56 | + npm run dev # for development, otherwise: npm run build |
| 57 | + ``` |
| 58 | + |
| 59 | +## TODO |
| 60 | +- [ ] Allow users to add courses |
| 61 | +- [x] Fix width when no course is selected |
| 62 | +- [x] Interface for viewing grade cutoffs |
| 63 | +- [x] [!] Add info for users, like "only one submission per course" |
| 64 | +- [x] Styling |
| 65 | +- [x] [!!] Refactor backend code |
| 66 | +- [x] [!] Use dropdown with search input for course selection |
| 67 | +- [x] Mobile responsiveness |
| 68 | +- [x] [!!] Replace temp and secret stuff with env variables |
| 69 | +- [x] [!!] use jwt for cookies |
| 70 | +- [x] Allow same course in different years |
| 71 | +- [x] Rate limiting |
0 commit comments