Skip to content
This repository has been archived by the owner on Apr 13, 2022. It is now read-only.

Latest commit

 

History

History
75 lines (43 loc) · 3.81 KB

README.md

File metadata and controls

75 lines (43 loc) · 3.81 KB
Raw

Backend Caen.Camp

Tests Top language Contributors License PRs Welcome

L'objectif des Caen.Camp.s est de créer un réseau de développeurs maillé au travers de rencontres (meetup, coding dojos, ...) organisées sur Caen.

Ce projet Backend regroupe les outils non-visible permettant la gestion de ce réseau (organisation des talks, présentations/annonces des prochaines rencontres, archives des rencontres passées, etc..).

Il s'agira dans un premier temps d'une API Rest exposant les talks (à venir et passé), les speakers, les lieux ayant hébergé les rencontres ainsi que les sponsors. Cette API servira 2 types de représentation :

  1. JSON
  2. JSON-LD

Nous envisageons également une version GraphQL de l'API.

Ce backend reposera principalement sur la brique technique API Plateform

Démarrage rapide

Le guide du contributeur détaille les pré-requis et les différents modes d’installation du projet. Mais en partant du postulat que php 7.4, composer et une base de données PostgreSQL en version 12 sont installés sur votre environnement, vous pouvez lancer l’installation du projet avec la commande

make install

et lancer le backend avec :

make start

Vous pouvez aussi peupler la base de données avec celles en markdown de l'ancien site (Gatsby) :

make db-init

Le backend est alors disponible sur http://localhost:8000

Swagger / OpenAPI

Une fois le back-end lancé, l'interface Swagger est disponible à http://localhost:8000/api.

Le contrat OpenAPI est disponible en json à http://localhost:8000/openapi.json et en yaml à http://localhost:8000/openapi.yaml.

Participer au projet

Vous souhaitez participer ? Merci à vous 👍

Et c’est très simple :

  • Si vous ne savez pas par où commencer, vous pouvez jeter un coup d’œil aux issues.
  • Voir les cartes des fonctionnalités à développer sur tableau Kanban du projet.
  • Une fois que vous savez quoi faire, vous pouvez consulter le guide du contributeur pour vous lancer.

Et si vous ne trouvez toujours pas quoi faire dans les issues existantes et/ou que vous avez d’autres idées, n’hésitez pas à créer une nouvelle issue.

Trouver de la documentation

Certes, le code et ses tests sont la meilleur documentation.

Pour autant, le code ne fait pas tous le projet. Vous trouverez donc, en plus de code, des informations sur le projet dans :

Si vous ne savez pas trop comment participer à un projet open-source, vous pouvez aussi jeter un oeil sur notre "Petit guide de participation aux projets des CaenCamp.s pour ceux qui ne saurait pas trop par où commencer."

License

Les projets des Coding Caen.Camp.s sont sous license GNU GPLv3