MójProfesor - wszystkie opinie na temat Twoich Prowadzących!

Opis projektu | Funkcjonalności | Demo | Konfiguracja | Struktura projektu | Kontrybutorzy

📝 Opis projektu

MójProfesor to odnowiona wersja doskonale znanego wszystkim Studentom portalu z opiniami o Prowadzących. Tylko tutaj dowiesz się, z kim będziesz miał zajęcia w następnym semestrze, co na temat Twoich Prowadzących sądzą inni studenci, a także na co zwrócić uwagę podczas nauki i na jakie zajęcia warto się zapisać.

Masz własne przemyślenia na temat zajęć prowadzonych na Twojej uczelni? Nie zgadzasz się z opiniami dodanymi przez innych Użytkowników? A może chcesz osobiście docenić pracę swojego ulubionego Prowadzącego? Dodaj swoją opinię i pomóż innym Studentom rozwiać swoje wątpliwości!

A kiedy dowiesz się wszystkiego na temat swoich Prowadzących, daj nam znać, czy nasz projekt Ci się spodobał i zostaw gwiazdkę, aby zmotywować nas do dalszej pracy ☺️!

🎯 Fukcjonalności

• Wyszukiwanie Profesora

Aplikacji MójProfesor pozwoli Ci znaleźć Twojego Profesora, bez konieczności rejestracji! Wystarczy, że podasz imię i nazwisko Prowadzącego i już po chwili dowiesz się, jak oceniają go inni Studenci.
.

• Rejestracja

Możesz również dołączyć do naszej społeczności i zarejestrować się. Zapewniamy pełną anonimowość 🤫 - przy rejestracji poprosimy Cię jedynie o adres e-mail.
.

• Logowanie

Zaloguj się, aby móc korzystać ze wszystkich funkcjonalności naszej aplikacji. E-mail, hasło i... nasza aplikacja jest w pełni do Twojej dyspozycji!
.

• Dodawanie opinii

Jako zalogowany Użytkownik możesz podzielić się ze wszystkimi swoją oceną na temat Prowadzących. Tutaj też przypominamy o pełnej anonimowości 🤫!
.

• Dodawanie Profesora

Nie znalazłeś swojego Profesora? Nic straconego! Dodaj go do naszej bazy i jako pierwszy dodaj ocenę. Inni Studenci będą ci wdzięczni 😉!
.

🚀 Live demo

Chcesz już teraz przetestować naszą aplikację? Kliknij tutaj!

💻 Uruchomienie projektu

Aby uruchomić ten projekt musisz wcześniej zainstalować Node.js oraz Docker na swoim komputerze. Następnie wykonaj poniższe kroki:

Pobierz repozytorium:

git clone https://github.com/bartq98/mojProfesor.git

Przejdź do folderu z projektem:

cd mojProfesor

Uruchom Dockera:

docker-compose up --build --force-recreate -d

Przejdź do podfolderu frontend:

cd frontend

Zainstaluj zależności:

npm install

Uruchom aplikację:

npm start

Uruchom przeglądarkę, wejdź na localhost:3000 i ciesz się działającą apikacją!

Wykorzystywane porty:

Service Hostname IP Ports exposed Purpose

api mojprofesor_api_1 172.18.0.3 7000->80 Spring-boot API

postgres_db mojprofesor_postgres_db_1 172.18.0.2 6432->5432 Database

Service	Hostname	IP	Ports exposed	Purpose
api	mojprofesor_api_1	172.18.0.3	7000->80	Spring-boot API
postgres_db	mojprofesor_postgres_db_1	172.18.0.2	6432->5432	Database

Dokumentacja backend'u:

http://localhost:7000/swagger-ui/index.html

🌵 Struktura projektu

mojProfesor
├───backend
│   ├───.mvn
│   │   └───wrapper
│   ├───src
│   │   ├───main
│   │   │   ├───java
│   │   │   │   └───com
│   │   │   │       └───mojprofesor
│   │   │   │           └───backend
│   │   │   │               ├───configuration
│   │   │   │               │   └───jwt
│   │   │   │               ├───controller
│   │   │   │               ├───entity
│   │   │   │               ├───exception
│   │   │   │               ├───payload
│   │   │   │               ├───repository
│   │   │   │               └───service
│   │   │   └───resources
│   │   └───test
│   │       └───java
│   │           └───com
│   │               └───mojprofesor
│   │                   └───backend
│   └───target
│       ├───classes
│       │   └───com
│       │       └───mojprofesor
│       │           └───backend
│       │               ├───configuration
│       │               │   └───jwt
│       │               ├───controller
│       │               ├───entity
│       │               ├───exception
│       │               ├───payload
│       │               ├───repository
│       │               └───service
│       ├───generated-sources
│       │   └───annotations
│       ├───generated-test-sources
│       │   └───test-annotations
│       ├───maven-status
│       │   └───maven-compiler-plugin
│       │       ├───compile
│       │       │   └───default-compile
│       │       └───testCompile
│       │           └───default-testCompile
│       └───test-classes
│           └───com
│               └───mojprofesor
│                   └───backend
└───frontend
    ├───public
    └───src
        ├───assets
        │   ├───css
        │   └───img
        ├───components
        │   ├───common
        │   │   ├───Input
        │   │   ├───Layout
        │   │   ├───Mark
        │   │   ├───SignedIcon
        │   │   ├───Star
        │   │   ├───StarRating
        │   │   └───Text
        │   ├───login
        │   ├───ProfesorDetails
        │   └───ProfessorsView
        ├───dal
        ├───hooks
        ├───store
        │   └───slices
        ├───typing
        │   └───interfaces
        ├───utils
        │   └───constants
        └───views