This is a full‑stack note‑taking platform with a React + Vite frontend, a Django REST API backend, and a PostgreSQL database running in Docker. It offers JWT-based authentication, course-linked notes, responsive UI components, and interactive CRUD workflows for organizing and reviewing university material and exams.
- Centralizes lecture slides, textbook excerpts, and online resources by course.
- Secure registration, login, and JWT-protected routes for private notes.
- Create, edit, and delete notes linked to specific courses.
- Filter and browse notes by course for focused revision.
- Clean, responsive UI optimized for laptops and mobile devices.
- Dockerized services for consistent, reproducible local deployments.
These steps assume no prior developer experience—just follow them in order.
- Install Docker Desktop from the official Docker website and open it.
- Download this project’s code from GitHub ("Code → Download ZIP"), then unzip the folder.
- Open a terminal and navigate into the project folder, for example:
cd UniNotes - Create a file named
.envin the project root and add:DATABASE_PASSWORD=yourStrongPasswordHere VITE_API_URL=http://backend:8000
- In the same terminal, start everything with:
docker compose up --build
- Wait until the logs show the backend and frontend are running, then open your browser at:
- Frontend: http://localhost:5173
- API (for reference): http://localhost:8000
This project was predominantly designed to help any student in need, feel free to clone and rename this project to use for your own purposes. Be as creativeas you wish!
If you found an issue or would like to submit an improvement to this project, please submit an issue using the issues tabs above. If you would like to submit a PR with a fix, reference the issue you created!
This project is licensed under the MIT License.