mariuszrudnik/back-end-megak-headhunter

📔 Spis treści

• Wstęp
• Opis projektu
  • Zastosowane technologie
  • Funkcjonalności
  • Konfiguracja projektu
• Uruchomienie projektu
  • Instalacja
  • Uruchomienie lokalne
• Przeznaczenie projektu
• Endpointy
• Przyszłe aktualizacje
• Licencja
• Użyte paczki
• Frontend
• Podziękowania

📌 Wstęp

Headhunter to projekt powstały w ramach etapu bonusowego kursu MegaK, w którym uczestnicy próbują stworzyć platformę ułatwiającą kontakt z przedstawicielami HR w celu znalezienia przyszłej pracy.

🌟 Opis projektu

• Specyfikacja projektu: https://docs.google.com/document/d/1j3iltSfaJXB8lVi5dwApL9UU0ze7A8kz9DBDChIVwfw/edit
• Makiety widoków: https://xd.adobe.com/view/864faeb9-d762-4277-a5d1-5b7565dcf543-d31c/

👾 Zastosowane technologie

Strona klienta

• Typescript
• React.js
• Sass

Strona serwera

• Typescript
• Nest.js

Baza danych

• MySQL

🎯 Funkcjonalności

• Dodawanie użytkowników z pliku JSON
• Rejestrowanie użytkowników przy użyciu linka aktywacyjnego
• Zaimplemetowanie autoryzacji i autentykacji przy użyciu JWT
• Aktualizowanie danych profilowych
• Zaimplementowanie powiadomień mailowych z użyciem cron
• Podział na role z ograniczonym dostępem danych

🔑 Konfiguracja projektu

W celu prawidłowego skonfigurowania projektu i połączenia z bazą danych należy odpowiednio wypełnić pola w zmiennej lokalnej databaseConfig znajdującej się w pliku ormConfig.ts

Ponadto w folderze import znajduje się plik simple-student.json do zaimportowania testowych danych dla użytkowników oraz wypełnione tabele dla bazy danych w kolejnym podkatalogu sql-insert

Admin dodawany ręcznie, po uruchomieniu aplikacji nest i powstaniu struktury bazy danych w tabeli user zamieszczamy dane opisane w linku, w sekcji "Endpointy".

🧰 Uruchomienie projektu

W tym projekcie domyślnym menadżerem paczek jest NPM.

⚙️ Instalacja

W katalogu projektu zainstaluj niezbędne zależności i paczki za pomocą komendy:

  npm install

🏃 Uruchomienie lokalne

Uruchomienie serwera

  npm start

Uruchomienie serwera ze śledzeniem zmian

  npm run start:dev

Zbudowanie wersji produkcyjnej aplikacji

  npm run build

Przy uruchamianiu wersji produkcyjnej, przed uruchomieniem skryptu npm run build należy zmienić ścieżkę w entities ormconfig.ts

dla wersji developerska entities: ['dist/**/**.entity{.ts,.js}']

dla wersji produkcyjnej entities: ['/**/**.entity{.ts,.js}']

👀 Przeznaczenie projektu

Aplikacja pozwala w prosty sposób łączyć osoby z działów HR firm, w tym Headhunterów [HR], z osobami poszukującymi pracy w IT.

Aplikacja ma pozwolić Kursantom Mega K [Kursant] zaprezentowanie swoich umiejętności, w sposób zunifikowany.

Aplikacja ma pozwolić HR na łatwe znalezienie odpowiednich kandydatów do pracy, przeprowadzenie z nimi rozmów i zaproponowanie współpracy.

Aplikacja ma pozwolić Administratorowi w zarządzaniu dostępem do bazy Kursantów.

Aplikacja nie ma stanowić bezpośredniej konkurencji dla portali pracy. Celem produktu jest uzupełnienie rynku, ze szczególnym uwzględnieniem Kursantów Mega K.

📬 Endpointy

Lista endpointów

🧭 Przyszłe aktualizacje

• widok RWD
• dodanie testów jednostkowych i integracyjnych
• zoptymalizowanie aplikacji

⚠️ Licencja

Distributed under the no License. See LICENSE.txt for more information.

💎 Użyte paczki

• TypeORM
• mysql2
• axios
• bcrypt
• cookie-parser
• nodemailer
• passport
• passport-jwt

🔻 Frontend

Readme

🤝 Podziękowania

Serdeczne podziękowania dla grupy 12 za podjęcie wyzwania i wspólną pracę przy projekcie.

W skład naszej grupy wchodzą:

Bartek, Hubert, Arek, Andrzej, Mariusz, Mateusz, Darek, Jakub,