cds-web/README.md
2022-10-21 03:12:22 +02:00

972 B

Site CDS

Structure du projet

  • .env : fichier de configuration
  • controllers : actions possibles par l'API REST
  • docs : doc swagger (swagger -i)
  • routes : configuration des routes
  • 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

Backend

Il faut mettre en place une base de données MongoDB. Il est nécessaire d'avoir une application Discord et une clé d'API Steam. Configurez ensuite le fichier example.env et renommez le en .env.

Lancez le serveur avec go run main.go.

Documentation

Installer swager avec Go et lancer le. Vous pouvez démarrer le serveur et aller sur le lien de la documentation pour pouvoir la lire en ligne.

go install github.com/swaggo/swag
swag init