Merge pull request #23 from MuNuChapterHKN/docs/readme

Added:

SonarCloud Analysis badges
- Getting started section
- New contributors to the Contributors section
- Updated:

Project description
- Useful Links
- Project structure
- .env RegEx in .gitignore

.gitignore

@@ -1,22 +1,22 @@
-node_modules/
-build/
-api/src/modules/GAuth/authInfo
-.idea/
-/**/.env
-/api/config/*.yaml
-/**/dist
-/**/*.tsbuildinfo
-.vscode
-
-tmp-*
-
-**/.DS_Store
-
-.*
-!.github
-!.gitignore
-!**/.swcrc
-
-**/*.sqlite
-
-coverage/
+node_modules/
+build/
+api/src/modules/GAuth/authInfo
+.idea/
+/**/*.env
+/api/config/*.yaml
+/**/dist
+/**/*.tsbuildinfo
+.vscode
+
+tmp-*
+
+**/.DS_Store
+
+.*
+!.github
+!.gitignore
+!**/.swcrc
+
+**/*.sqlite
+
+coverage/

README.md

@@ -1,25 +1,78 @@
-<img src="https://www.hknpolito.org/Signature/hkn_logo_blu.png" width="100">
+<p align="center">
+    <img src="https://www.hknpolito.org/Signature/hkn_logo_blu.png" width="100">
+</p>
 
-# HKrecruitment
+<h1 align="center">HKRecruitment</h1>
+<p align="center">Official HKN Polito recruitment platform 🚀</p>
 
-HKrecruitment is the platform used by HKN Polito to handle the recruitment process.
-
-This repository follows the strcuture:
-
-- **api** - API endpoints, back-end logic, and data storage
-- **frontend** - React Application UI
-- **shared** - Models, interfaces, and validation logic common to front-end and back-end
+<p align="center">
+<img alt="Quality Gate Status" src="https://sonarcloud.io/api/project_badges/measure?project=MuNuChapterHKN_HKrecruitment&metric=alert_status">
+<img alt="Coverage" src="https://sonarcloud.io/api/project_badges/measure?project=MuNuChapterHKN_HKrecruitment&metric=coverage">
+<img alt="Duplicated Lines (%)" src="https://sonarcloud.io/api/project_badges/measure?project=MuNuChapterHKN_HKrecruitment&metric=duplicated_lines_density">
+<img alt="Lines of Code" src="https://sonarcloud.io/api/project_badges/measure?project=MuNuChapterHKN_HKrecruitment&metric=ncloc">
+<img alt="Security Rating" src="https://sonarcloud.io/api/project_badges/measure?project=MuNuChapterHKN_HKrecruitment&metric=security_rating">
+</p>
 
 ## Useful Links
 
 [Reports](https://drive.google.com/drive/folders/1RqGVtzU4TV6RJPmtjZQPpHVybDpU6DZk?usp=sharing)
 
-[Trello](https://trello.com/b/vnLyKH85/hkrecruitment)
+[Tasks](https://github.com/orgs/MuNuChapterHKN/projects/3/views/2)
 
 [UI Mockups](https://miro.com/app/board/uXjVOdvzKAk=/)
 
 [Database Schema](https://app.diagrams.net/#G19QUWxP5BBB3tWXnATnHP8wFE4wW7NsXw)
 
+## Getting started
+
+### Requirements
+- [Node.js](https://nodejs.org/en/download/current), version >= 18 
+- [pnpm](https://pnpm.io/installation)
+- Either [Docker Compose](https://docs.docker.com/compose/install/) or a [PostgreSQL database](https://www.postgresql.org/download/)
+
+### 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](https://drive.google.com/file/d/1_TbKfKMlw9Rpy6H8AFWDVxRYtMCgsiy6/view?usp=drive_link) in the `/api` folder. It contains environmental variables used to connect to the database and for external services.
+
+#### Auth0
+Place this [.env file](https://drive.google.com/file/d/1o_HY3KvsCyTsTvY_BcIeymQy5TO6w8Ts/view?usp=drive_link) 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
+```Shell
+docker compose up # Spins up a PostgreSQL database
+
+pnpm dev:api # Starts the backend server
+``` 
+#### Frontend
+```Shell
+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](https://hknpolito.org/)
@@ -32,6 +85,10 @@ This repository follows the strcuture:
 
 - **Marco Pappalardo** - _React application_ - [HKN Polito](https://hknpolito.org/)
 - **Damiano Bonaccorsi** - _React application_ - [HKN Polito](https://hknpolito.org/)
+- **Isabella Lombardi** - _React application_ - [HKN Polito](https://hknpolito.org/)
+- **Filippo Goffredo** - _React application_ - [HKN Polito](https://hknpolito.org/)
+
+- **Alessio Menichinelli** - _DevOps_ - [HKN Polito](https://hknpolito.org/)
 
 ## License