Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 3.87 KB

README.md

File metadata and controls

95 lines (67 loc) · 3.87 KB

HKRecruitment

Official HKN Polito recruitment platform 🚀

Quality Gate Status Coverage Duplicated Lines (%) Lines of Code Security Rating

Useful Links

Reports

Tasks

UI Mockups

Database Schema

Getting started

Requirements

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

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.