Skip to content

Commit

Permalink
docs: updated project description, useful links, and contributors in …
Browse files Browse the repository at this point in the history
…README.md (#10)
  • Loading branch information
AlbertoBaroso authored Dec 7, 2023
1 parent 0a4de94 commit 27f282f
Showing 1 changed file with 29 additions and 11 deletions.
40 changes: 29 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,38 @@
<img src="https://hknpolito.org/wp-content/uploads/2018/05/hkn_logo_blu.png" width="100">
<img src="https://www.hknpolito.org/Signature/hkn_logo_blu.png" width="100">

# HKrecruitment
HKrecruitment is the platform used by HKN Polito to handle
the recruitment process. This repository contains three branches:
* **apiserver** - tracks the development of the API server
* **reactapp** - tracks the development of the front-end React application
* **documentation** - track the documentation for both the API server and the React application

Trello for project state https://trello.com/invite/b/T6YYVYW3/ATTI0e7257a02d61a8b4fe54ac88affe746346110847/hkrecruitment
HKrecruitment is the platform used by HKN Polito to handle the recruitment process.

## Authors
This repository follows the strcuture:

* **Riccardo Zaccone** - *API server* - [HKN Polito](https://hknpolito.org/)
* **Arianna Ravera** - *API server* - [HKN Polito](https://hknpolito.org/)
* **Marco Pappalardo** - *React application* - [HKN Polito](https://hknpolito.org/)
- **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

## Useful Links

[Reports](https://drive.google.com/drive/folders/1RqGVtzU4TV6RJPmtjZQPpHVybDpU6DZk?usp=sharing)

[Trello](https://trello.com/b/vnLyKH85/hkrecruitment)

[UI Mockups](https://miro.com/app/board/uXjVOdvzKAk=/)

[Database Schema](https://app.diagrams.net/#G19QUWxP5BBB3tWXnATnHP8wFE4wW7NsXw)

## Contributors

- **Riccardo Zaccone** - _API server_ - [HKN Polito](https://hknpolito.org/)
- **Arianna Ravera** - _API server_ - [HKN Polito](https://hknpolito.org/)
- **Vincenzo Pellegrini** - _API server_ - [HKN Polito](https://hknpolito.org/)
- **Alberto Baroso** - _API server_ - [HKN Polito](https://hknpolito.org/)
- **Marco De Luca** - _API server_ - [HKN Polito](https://hknpolito.org/)
- **Matteo Mugnai** - _API server_ - [HKN Polito](https://hknpolito.org/)
- **Pasquale Bianco** - _API server_ - [HKN Polito](https://hknpolito.org/)

- **Marco Pappalardo** - _React application_ - [HKN Polito](https://hknpolito.org/)
- **Damiano Bonaccorsi** - _React application_ - [HKN Polito](https://hknpolito.org/)

## 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](COPYING) file for details.

0 comments on commit 27f282f

Please sign in to comment.