batnoter api
v1.0.0
Il s'agit du service API de l'application Batnoter construite avec Golang.
Il expose les points de terminaison de repos à l'accès et à la gestion des notes de marque du référentiel GIT de l'utilisateur. Actuellement, il ne prend en charge que le référentiel GitHub pour le stockage et la gestion des notes.
1.18 ou supérieurLes commandes ci-dessous utilisent Docker pour démarrer le conteneur de la base de données.
make network
make postgres
make createdb La config.yaml est le fichier de modèle de configuration contenant des valeurs de configuration par défaut.
cp config.yaml .config.yaml L'application utilise le fichier .config.yaml pour obtenir les valeurs de configuration. Veuillez mettre à jour les valeurs d'espace réservées de ce fichier de configuration vers les véritables.
Assurez-vous que le fichier .config.yaml est configuré correctement et que le conteneur de base de données est opérationnel. Exécutez ensuite les commandes ci-dessous pour configurer le schéma DB et démarrer le serveur Web.
go run main.go migrateup
go run main.go serve Cela démarrera le serveur sur le port spécifié dans le fichier .config.yaml . Vous pouvez désormais accéder aux points de terminaison de l'API.
go test -v -cover ./...Cela exécutera tous les tests et imprime également le pourcentage de couverture de code.
Chaque contribution fait une différence
Lisez les directives de contribution avant de contribuer.
