Schooler is a web application that allows students to easily access resources and informations.
- Live timetable and class schedule
- Downloadable academic calendar
- Downloadable timetables
- Create/view annoucements
- View people and get contacts
- Download resources
- Frontend: NextJS with TypeScript (located in
frontend/) - Backend: FastAPI with sqlmodel (located in
backend/)
schooler/
├── backend/ # Python backend code & API
├── frontend/ # NextJS frontend source code & assets
├── LICENSE
├── README.md
-
Clone the repository:
git clone https://github.com/AungS8430/schooler.git cd schooler -
Install frontend dependencies:
cd frontend pnpm install -
Install backend dependencies:
cd ../ pip install -r requirements.txt
Add data to backend/volumes the files include**
...
backend/
├── ...
├── volumes
├── ├── academicInfo.json
├── ├── info.json
├── ├── override.json
├── ├── resources.json
├── ├── slots.json
├── ├── special.json
├── ├── timetable.json
├── ...
...
Please view example in the respective files.
Create .env inside backend and frontend folders, view .env.example inside the respective directories.
-
Start the backend server:
cd backend fastapi run server.py -
Start the frontend development server:
cd ../frontend pnpm start -
Open http://localhost:3000 in your browser.
Contributions are welcome!
If you have suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
Steps:
- Fork the repository
- Create your feature branch (
git checkout -b feature/my-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin feature/my-feature) - Open a Pull Request
This project is licensed under the MIT License.
See LICENSE for details.
For questions or feedback, open an issue.