[Documentation] Add meaningful README in /api - Githubissues

visevol / GithubVisualisation

PFE028 Été 2024

MIT License

0 stars 1 forks source link

[Documentation] Add meaningful README in /api #49

Closed zergov closed 1 day ago

zergov commented 3 days ago

Closes: https://github.com/visevol/GihubVisualisation/issues/24

Add a meaningful README in the /api directory that explains how to get a working environment to run the api locally. You can preview the documentation here: https://github.com/visevol/GihubVisualisation/blob/zgv/api-documentation/api/README.md

I also added 2 documentation pages:

endpoints: lists the endpoints of the api
rake tasks: lists the rake tasks available in this project