DevCollective.io

DevCollective.io

Développement local

1. Installer Docker

Vous devrez installer Docker pour activer Postgres. Utilisateurs de Windows, veuillez vous assurer d'installer des extensions WSL2, car celles-ci sont requises pour que Postgres fonctionne correctement.

2. Installez le fil

Pour diverses raisons, ce projet dépend du fil. Vous pouvez l'installer en utilisant:

npm install -g yarn

3. Installation du fil

Cela installera vos dépendances.

yarn

4. Démarrez votre base de données

yarn dbup

Cette étape crée 2 bases de données Postgres dans Docker. Celui sur le port 10800 est le développement, tandis que celui du port 10801 est destiné aux tests unitaires.

Utilisateurs de Windows:

Si vous voyez cette erreur:

 The command 'docker-compose' could not be found in this WSL 2 distro.

Assurez-vous ensuite dans votre bureau Docker sous Paramètres / Général que "Utilisez le moteur basé sur WSL 2" est vérifié.

5. Exécutez Pristine pour créer toutes vos bases de données.

Nous avons une commande d'immatriculation, yarn pristine , qui recréent et réensemement la base de données. Vous pouvez utiliser cette commande à tout moment pour effacer votre base de données et la réinitialiser.

yarn pristine

Exécutez Pristine chaque fois que la DB change.

Vierge doit être exécuté après chaque changement de base de données afin de mettre à jour votre base de données avec les dernières migrations.

Pristine peut être utilisé pour réinitialiser votre base de données

Virginie peut être exécutée à tout moment pour réinitialiser votre base de données à un état propre. Cela peut être utile dans de nombreuses situations.

Si vous rencontrez des problèmes que Pristine ne résout pas

Si vous rencontrez des problèmes plus profonds, vous voudrez peut-être détruire vos instances de Postgres et commencer à zéro absolu. Il y a une commande qui détruira toutes les images Docker, conteneurs, volumes qui ne sont pas en cours d'exécution. Tout d'abord, vous voudrez arrêter tous les processus Docker liés à ce projet, puis exécuter docker system prune -a . Remarque: Il s'agit d'une commande dangereuse qui détruira tout ce qui ne s'exécute pas actuellement dans Docker, y compris les projets non DC.IO.

6. Déclarer le numéro de port personnalisé pour démarrer la demande

** La création de ce fichier est facultative. Si vous ne créez pas ce fichier dans un environnement Dev, les valeurs par défaut seront utilisées à partir du fichier dev.env présent dans le dossier de développement.

Créez d'abord le fichier dev-override.env dans le dossier de développement présent dans le répertoire racine. Copiez et collez ensuite les champs suivants dans votre fichier.

 PORT= *

À la place de *, vous pouvez déclarer votre propre numéro de port disponible dans votre machine.

7. Démarrez votre serveur

Enfin, vous pouvez exécuter la commande yarn dev (Windows: yarn dev:win ) pour démarrer le serveur. Cela servira à la fois le frontend et le backend sur le port 3000.

8. Facultatif: configurer les extensions VScode

Le menu de débogage de VScode, qui s'appuie sur Launch.json, a été rempli de quelques options d'exécution. L'un exécute le serveur, tandis que l'autre exécute les tests unitaires. Les deux sont activés avec des points d'arrêt et peuvent être un excellent moyen pour vous également déboguer votre code si nécessaire.

Ce projet est configuré pour bien jouer avec VScode Jest. Il exécutera vos tests en arrière-plan et vous donnera également des boutons de "débogage" utiles pour des tests spécifiques. Hautement recommandé pour tout travail backend.

L'installation de VScode GraphQL permet la mise en évidence de la syntaxe GraphQL. Recommandé pour le travail GQL.

Docs utiles

Comment faire votre première demande de traction - Merci, Julio Alcantara! Comment créer de nouvelles entités comment synchroniser votre dépôt avec le code mis à jour

Configuration de production

Si vous déploiez en production, placez d'abord vos fichiers de configuration dans /etc/mintbean-v4/config/* . Ensuite, exécutez yarn start .