Blagues-api.fr

Site de l'API de Blagues françaises collaborative et Open Source

Utilisation

Retrouvez la documentation de l'API ainsi des modules directement sur le site blagues-api.fr.

Contribuer

Le projet est open-source ce qui signifie que vous pouvez contribuer et faire évoluer le projet.
Rendez-vous sur la page des issues, sélectionnez une issue qui vous intéresse et faites une demande pour y être assigné.

Les issues ayant le label good first issue sont les plus simples.

Installation de Docker

Le projet fonctionne avec Docker, il vous permettra d'obtenir le même environnement qu'en production.
Si vous êtes sous Windows ou Mac, il vous faudra installer Docker Desktop.

⚠️ Si vous souhaitez tout de même contribuer au projet sans utiliser Docker qui n'est absolument pas recommandé, lancez l'instance de développement avec la commande yarn dev.

Installation des dépendances du projet

yarn install # npm install

Configuration de l'api

Pour lancer le site avec Docker il vous faut cloner le repo principal dans le meme dossier ou vous avez cloner le site puis activer le service api comme ci-dessous dans votre .env

api-service=true

⚠️ Les commandes suivantes sont a faire dans le dossier principal de l'api

Génération de l'image de développement Docker

yarn run dev:build # npm run dev:build

Lancement de l'instance de développement

yarn dev # npm run dev

🎉 Votre instance est lancée, vous pouvez dès à présent vous lancer dans le développement de l'issue choisie

Support

Voici quelques liens pour obtenir de l'aide :

Site web: www.blagues-api.fr
Discord: Blagues API
Twitter: @DraftMan_Dev

Blagues-API / blagues-api.fr

readme