DevCollective.io

DevCollective.io

Lokale Entwicklung

1. Installieren Sie Docker

Sie müssen Docker installieren, um Postgres zu aktivieren. Windows -Benutzer, bitte stellen Sie sicher, dass Sie WSL2 -Erweiterungen installieren, da diese für Postgres korrekt funktionieren.

2. Installieren Sie Garn

Aus einer Vielzahl von Gründen hängt dieses Projekt vom Garn ab. Sie können es mit:

npm install -g yarn

3. Garn installieren

Dadurch werden Ihre Abhängigkeiten installiert.

yarn

4. Starten Sie Ihre Datenbank

yarn dbup

In diesem Schritt werden 2 Postgres -Datenbanken in Docker erstellt. Der in Port 10800 ist die Entwicklung, während der in Port 10801 für Unit -Tests bestimmt ist.

Windows -Benutzer:

Wenn Sie diesen Fehler sehen:

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

Stellen Sie dann sicher, dass in Ihrem Docker -Desktop unter Einstellungen/General die WSL 2 -basierte Engine überprüft wird.

5. Führen Sie makellos aus, um alle Ihre Datenbanken zu erstellen.

Wir haben einen günstigen Befehl, yarn pristine , der die Datenbank neu erstellt und erneut senkt. Sie können diesen Befehl jederzeit verwenden, um Ihre Datenbank zu löschen und zurückzusetzen.

yarn pristine

Rennen Sie jedes Mal, wenn sich der DB ändert, makellos.

Nach jeder DB -Änderung muss makellos ausgeführt werden, um Ihre Datenbank mit den neuesten Migrationen zu aktualisieren.

Pristine kann verwendet werden, um Ihre Datenbank zurückzusetzen

Pristine kann jederzeit ausgeführt werden, um Ihre Datenbank in einen sauberen Zustand zurückzusetzen. Dies kann in vielen Situationen nützlich sein.

Wenn Sie auf Probleme stoßen, die makellos nicht lösen

Wenn Sie auf tiefere Probleme stoßen, möchten Sie möglicherweise nur Ihre Postgres -Instanzen zerstören und von absoluter Kratzer beginnen. Es gibt einen Befehl, der alle Docker -Bilder, Container und Bände zerstört, die derzeit nicht ausgeführt werden. Zuerst möchten Sie alle Docker -Prozesse in diesem Projekt stoppen und dann docker system prune -a ausführen. Hinweis: Dies ist ein gefährlicher Befehl, der alles zerstört, was derzeit nicht in Docker ausgeführt wird, einschließlich aller Nicht-DC.IO-Projekte.

6. Deklarieren Sie die benutzerdefinierte Portnummer, um die Anwendung zu starten

** Die Erstellung dieser Datei ist optional. Wenn Sie diese Datei nicht in der Dev -Umgebung erstellen, werden Standardwerte von dev.env -Datei verwendet, die in Devordner vorhanden sind.

Erstellen Sie zunächst dev-override.env-Datei in Devordner, die im Root-Verzeichnis vorhanden sind. Kopieren Sie dann die folgenden Felder in Ihre Datei.

 PORT= *

Anstelle von * können Sie Ihre eigene Portnummer deklarieren, die in Ihrer Maschine verfügbar ist.

7. Starten Sie Ihren Server

Schließlich können Sie den Befehlsgarn yarn dev (Windows: yarn dev:win ) ausführen, um den Server zu starten. Dadurch wird sowohl das Frontend als auch das Backend in Port 3000 dienen.

8. Optional: VSCODE -Erweiterungen einrichten

Das Debugging -Menü auf VSCODE, das auf Start.json basiert, wurde mit einigen Laufoptionen bevölkert. Einer führt den Server aus, während der andere die Unit -Tests ausführt. Beide sind mit Haltepunkten aktiviert und können für Sie eine großartige Möglichkeit sein, Ihren Code bei Bedarf zu debuggen.

Dieses Projekt ist so eingerichtet, dass es mit VSCODE Scherz gut abspielt. Es werden Ihre Tests im Hintergrund ausgeführt und Ihnen auch nützliche "Debug" -Stasten für bestimmte Tests erhalten. Sehr zu empfehlen für alle Backend -Arbeiten.

Das Installieren von VSCODE GraphQL aktiviert die GraphQL -Syntax -Hervorhebung. Empfohlen für GQL -Arbeit.

Nützliche Dokumente

So stellen Sie Ihre erste Pull -Anfrage - danke, Julio Alcantara! So erstellen Sie neue Entitäten So synchronisieren Sie Ihr Repo mit aktualisiertem Code

Produktionskonfiguration

Wenn Sie für die Produktion bereitgestellt werden, geben Sie Ihre Konfigurationsdateien zunächst in /etc/mintbean-v4/config/* . Dann laufen Sie yarn start .