cds-web/README.md

33 lines
972 B
Markdown
Raw Normal View History

2022-10-09 00:15:25 +00:00
# Site CDS
## Structure du projet
* .env : fichier de configuration
2022-10-21 01:12:22 +00:00
* controllers : actions possibles par l'API REST
* docs : doc swagger (swagger -i)
* routes : configuration des routes
2022-10-09 00:15:25 +00:00
* views : fichiers html dynamiques
* dao : fichiers pour faire des requetes en BDD
* models : structures utilisées pour manipuler le contenu de la base de données
## Lancement
2022-10-21 01:12:22 +00:00
### Backend
2022-10-09 00:15:25 +00:00
Il faut mettre en place une base de données [MongoDB](https://www.mongodb.com/).
Il est nécessaire d'avoir [une application Discord](https://discord.com/developers/)
et [une clé d'API Steam](https://steamcommunity.com/dev).
Configurez ensuite le fichier `example.env` et renommez le en `.env`.
Lancez le serveur avec `go run main.go`.
2022-10-21 01:12:22 +00:00
### Documentation
Installer swager avec Go et lancer le. Vous pouvez démarrer le serveur et aller
sur le lien [de la documentation](localhost:8080/swagger) pour pouvoir la lire en ligne.
```
go install github.com/swaggo/swag
swag init
```