Rate UKMA

Rate. Review. Discover your best courses at NaUKMA.

📌 Overview

Rate UKMA is a web platform designed for students of NaUKMA to share and view feedback on university courses. Our goal is to create a centralized hub for course reviews and ratings, empowering students to make more informed decisions about their academic choices.

The problem. To understand what a course is really like, a student has to ask around: older students, friends, acquaintances, course chats. In my.ukma.edu.ua a course is a name, a credit count and an annotation, and credits show the general workload, not the real one: the two do not always match. So the experience lives with people, scattered and never written down, and there is no single place to find it before enrolment.

Target user. NaUKMA students, mostly 2nd to 4th year bachelor's students choosing electives for the next year and planning their semester. They read reviews and leave ratings, and writing a review is optional. Access is student-only, via a NaUKMA Outlook account.

The idea. One place for the whole course choice: student reviews with usefulness and difficulty ratings and an interactive course map, live at rateukma.com, plus the semester planning and analytics we are building now.

How it started. Rate UKMA began as a project in one of our university courses and grew into a product. From the first days we treated it as a product rather than an assignment to hand in, and shipped it: the site has been live since 2025, about 300 students come to it every month, with a peak in the spring registration window. The first point was a hand-made chart someone shared in a student chat, courses plotted on two axes, usefulness and difficulty. The chart was not ours, but the format stuck: we turned the idea into a product, the same map built from real student reviews.

Staging: https://staging.rateukma.com

Live: https://rateukma.com

Releases: https://github.com/ukma-cs-ssdm-2025/rate-ukma/releases

🧩 Features

• Rate courses on difficulty and usefulness, with optional written reviews
• Comment on reviews and vote them up or down
• A personal page with your own ratings, grouped by year
• Feed of the latest reviews and university announcements
• Notifications about votes and comments on your ratings
• Interactive course map and per-course analytics
• Search and filter courses by speciality, instructor, semester, credits and rating
• Anonymity to protect student privacy and prevent bias
• NaUKMA Outlook authentication for secure student-only access

🧑‍💻 Team

Name	Role	GitHub
Anastasiia Aleksieienko	Product engineer	@stasiaaleks
Kateryna Bratiuk	Product engineer	@katerynabratiuk
Andrii Valenia	Product engineer	@Fybex
Milana Horalevych	Product engineer	@miqdok
Anastasiia Dvoilenko	Product engineer	@anastasiaaq

Everyone writes and reviews code; the semester tracks are split across the team.

🛠️ Tech Stack

• Backend: Django, Django REST Framework
• Frontend: React, TypeScript, TanStack, Tailwind
• Database: PostgreSQL, Redis
• Infrastructure: Docker, Hetzner, GitHub Actions, Sentry
• API Contract: OpenAPI

📚 Additional Documentation

For comprehensive project information, please refer to the following documents:

• Team Charter - Detailed information about our team structure, workflows and collaboration guidelines
• Project Description - An overview of our project's core idea, goals and key features
• Developer Onboarding - Zero-to-first-MR guide: repo map, backend/frontend tours, conventions
• Architecture - High-level design, ADRs and UML diagrams
• User Stories - Detailed information about project user stories
• Requirements Specification - Functional and non-functional requirements
• Traceability Matrix - Mapping of user stories to functional and non-functional requirements
• API Documentation - OpenAPI schema generation, Swagger UI setup and API versioning guide
• API Design - REST API architecture, resource model and design decisions
• API Quality Attributes - Performance, security, reliability, usability, and maintainability targets for the API
• Testing Strategy - Comprehensive testing approach, tools, and quality gates

🚀 Running Project

Prerequisites

• Docker Engine 24.0+

• Docker Compose V2

• Git

• uv package manager (for local development) Installation

  # Install uv (Linux/macOS)
  curl -LsSf https://astral.sh/uv/install.sh | sh
  
  # Or using pip
  pip install uv
  

Starting Development Environment

1. Clone the repository:

   git clone <repository-url>
   cd rate-ukma
   

2. Create and configure environment variables:

   cd src
   cp .env.sample .env
   

   Add actual values to .env.

3. Build containers and start development environment:

   docker compose --profile dev up -d --build
   

   The following services will be available:

   • Webapp: http://localhost:3000
   • Backend API: http://localhost:8000
   • Admin Panel: http://localhost:8000/admin

4. Create a superuser:

   docker exec -it <backend_container_name> bash
   python manage.py createsuperuser
   
   # Or one-liner:
   docker exec -it <backend_container_name> python manage.py createsuperuser
   

Making Migrations

docker exec -it <backend_container_name> bash
python manage.py makemigrations
# Or a similar one-liner as above

Then restart the containers - migrations are run on startup

Pre-commit Hooks Setup

Pre-commit is installed with other dependencies. To use it:

1. Install git hooks:

   pre-commit install
   

   This installs git hooks from .pre-commit-config.yaml into your local repository.

   Pre-commit will automatically run before every commit.

2. To run pre-commit manually:

   pre-commit run --all-files # all files
   pre-commit run --files <file1> <file2> <file3> # specific files
   pre-commit run # all staged files
   

💻 Development Resources

For detailed development instructions, IDE setup, and additional commands:

• Backend Development: See Backend README - Django setup, virtual environment, and IDE integration
• Frontend Development: See Webapp README - React setup, local dependencies, and IDE integration

Important: While the project runs entirely in Docker, installing dependencies locally provides better IDE integration, IntelliSense, and real-time linting.

License

Copyright (C) 2025-present Anastasiia Aleksieienko, Kateryna Bratiuk, Andrii Valenia, Milana Horalevych

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.