Blagues API

API de Blagues françaises collaborative et Open Source

Modules

Afin de simplifier l'utilisation de Blagues API, des modules ont été créés :

Dans le cas où aucun module n'a été créé vous pouvez utiliser l'api standard.

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 veillez à installer et exécuter les mêmes scripts que ceux qui sont faits dans le fichier Dockerfile.dev de développement, ensuite lancez l'instance de développement avec la commande yarn dev:legacy.

Installation des dépendances du projet

yarn install # npm install

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

yarn 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

FAQ

Pouvons-nous proposer des blagues ?
- Oui bien sûr en rejoignant le serveur Blagues API, des commandes telles que /suggestion ont été créé afin de rendre la proposition de nouvelles blagues plus facile !

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