HKRecruitment

Official HKN Polito recruitment platform 🚀

Useful Links

Reports

Tasks

UI Mockups

Database Schema

Getting started

Requirements

• Node.js, version >= 18
• pnpm
• Either Docker Compose or a PostgreSQL database

Clone the repository

git clone https://github.com/MuNuChapterHKN/HKrecruitment.git

Install dependencies

From the root folder run:

pnpm install

Setup environment

Database

Place this .env file in the /api folder. It contains environmental variables used to connect to the database and for external services.

Auth0

Place this .env file in the /frontend folder. It contains environmental variables used to interact with Auth0.

Run the project

Execute the following commands from the root folder.

Backend

docker compose up # Spins up a PostgreSQL database

pnpm dev:api # Starts the backend server

Frontend

pnpm dev:web # Runs the frontend

Project structure

This repository follows the structure:

• api - API endpoints, back-end logic, and data storage
• frontend - React Application UI
• shared - Models, interfaces, and validation logic common to frontend and backend

Contributors

• Riccardo Zaccone - API server - HKN Polito

• Arianna Ravera - API server - HKN Polito

• Vincenzo Pellegrini - API server - HKN Polito

• Alberto Baroso - API server - HKN Polito

• Marco De Luca - API server - HKN Polito

• Matteo Mugnai - API server - HKN Polito

• Pasquale Bianco - API server - HKN Polito

• Marco Pappalardo - React application - HKN Polito

• Damiano Bonaccorsi - React application - HKN Polito

• Isabella Lombardi - React application - HKN Polito

• Filippo Goffredo - React application - HKN Polito

• Alessio Menichinelli - DevOps - HKN Polito

License

HKRecruitment 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. See the COPYING file for details.