Skip to content

Latest commit

 

History

History
134 lines (84 loc) · 4.66 KB

README.fr.md

File metadata and controls

134 lines (84 loc) · 4.66 KB

Opus API

Table des matières

Description et contexte

C'est le service qui gère les informations de Opus.

Référence de service

Conditions

Comment commencer

Souhaitez-vous collaborer? Voici les étapes à suivre pour vous mettre au travail.

Dépendances

Préparation de l'environnement de développement

Pour commencer le développement il est nécessaire de faire quelques configurations avant de maintenir le standard du projet.

Comme vous l'avez peut-être déjà vu, Visual Studio Code est le principal éditeur de texte utilisé dans ce projet, cependant, n'hésitez pas à utiliser n'importe quel éditeur ou IDE de votre choix.

Cloner le projet

Vous pouvez cloner le projet dans n'importe quel répertoire de votre choix, mais nous vous recommandons de créer un répertoire opus sur la base de votre système d'exploitation.

mkdir ~/opus
git clone https://github.com/Streamelopers/opus-api.git

Si vous avez correctement défini la variable d'environnement de l'exécutable Visual Studio Code, vous pouvez choisir d'ouvrir le projet avec la commande suivante :

code opus-api

Installation d'extensions

Si vous n'utilisez pas Visual Studio Code, ignorez cette étape.

Il est très probable que lorsque vous ouvrez le projet pour la première fois dans Visual Studio Code, une alerte semblable à celle-ci s'affiche : Recommandation d'installation d'extension

Cela facilite l'installation d'extensions qui faciliteront le développement lors de votre collaboration avec ce projet.

Si l'alerte de recommandation d'installation ne s'affiche pas, vous pouvez installer ces dépendances manuellement. Vous pouvez jeter un œil au fichier .vscode/extensions.json.

Création d'un fichier de variables d'environnement

Le test décisif pour savoir si une application a toute sa configuration correctement séparée du code est de vérifier que le code de base peut être converti en open source à tout moment, sans compromettre les informations d'identification. Pour cette raison, nous devons créer notre fichier de variables d'environnement .env. Pour cela, nous exécutons la commande suivante :

cp .env.exemple .env

N'hésitez pas à modifier les identifiants à votre guise.

Exécuter le projet

Pour faciliter le démarrage de votre collaboration et éviter les problèmes de dépendance, le projet implémente docker-compose.

N'hésitez pas à lancer le projet sans utiliser Docker, mais il est important de savoir que vous ne pourrez pas compter sur le soutien de la communauté. Si vous ne connaissez pas Docker, vous pouvez rapidement apprendre les bases ici.

On navigue jusqu'au répertoire où se trouve le projet :

cd ~/opus/opus-api

Nous exécutons la commande suivante via npm :

npm run start:docker

Ce script exécute la commande docker-compose up suivante qui à son tour se nourrit du fichier docker-compose.yml.

Après cela, le projet devrait démarrer dans quelques secondes.

Définition de la ressource

Vous pouvez visualiser les ressources du service en accédant à: http://localhost:5000/swagger.

Pile de développement

Serveur

  • Node.js
    • Nest.js Framework
  • Docker

Base de données

  • Postgres

Clause de non-responsabilité

Les informations exposées via ce service proviennent de la base de données locale.

Contributeurs