diff --git a/README.md b/README.md new file mode 100644 index 0000000..43d067a --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# cadoles-profile + +Micro application de modification de profil LDAP + +## Démarrer avec les sources + +### Dépendances + +- [Go >= 1.11](https://golang.org/) +- [GNU Make](https://www.gnu.org/software/make/) + +### Procédure + +```shell +make deps # Installer les dépendances +make vendor # Récupérer localement les dépendances +make watch # Observer les sources et recompiler/exécuter à la volée le serveur +``` + +Le fichier de configuration sera généré automatiquement dans `data/server.conf`. Vous pouvez le modifier pour correspondre à votre environnement de développement. + +Par défaut, l'application devrait être disponible à l'adresse http://localhost:3000/. \ No newline at end of file