AndcultureCode.DotnetReact.Boilerplate

AndcultureCode.dotnetract.Boilerplate

Codename: Schwerkraftstiefel (GB)

---

Erste Schritte

Technologien

• Dotnet Core 6.0
• Knoten 8.16
• NPM 6
• Reagieren Sie 16.13
• SQL Server 2017+
• TypeScript 3.8

Entwicklungsaufbau

1. Datenbanken

SQLServer 2017 (bis zur Genehmigung: könnte postgreSQL sein)

1. Installieren Sie Microsoft SQL Server 2017

2. Erstellen Sie die folgende Datenbank

   • Entwicklung: GravityBootsApi (Einzelheiten siehe Appsettings.json.)

3. Benutzer konfigurieren.

   • Holen Sie sich Anmeldeinformationen aus der oben aufgeführten Datei appsettings.json .
   • Klicken Sie mit der rechten Maustaste auf Sicherheit und wählen Sie dann neu> Login aus
     • Fügen Sie den Login -Namen hinzu
     • Wählen Sie die SQL Server -Authentifizierung
       • Passwort hinzufügen
       • Die Auswahl erzwingen die Passwortrichtlinie und setzen Sie den Kennwortablauf durch
   • Wählen Sie Serverrollen über eine Seite aus
     • Lokale Entwicklung: Wählen Sie alle aus
   • Wählen Sie Benutzerzuordnen aus einer Seite auswählen
     • Sowohl für die Entwicklungs- als auch für die Testdatenbanken:
       • Lokale Entwicklung: Wählen Sie alle Rollenmitgliedschaften aus

2. Backend: Dotnet Core CSHARP

Installieren Sie Dotnet Core 3.1 SDK & Laufzeit

3. Frontend: React TypeScript reagieren

Installieren Sie NodeJS 8.16 / NPM 6

4. Cli

Es gibt ein zentrales and-cli , um Builds, Tests, Bereitstellungen usw. für die verschiedenen Aspekte des Projekts zu verwalten.

and-cli

Im Folgenden finden Sie einige Grundlagen, um Ihnen den Einstieg zu erleichtern. Es gibt jedoch noch viele weitere Befehle und Optionen für die Verwaltung dieses und anderer Projekte, die in der and-cli gefunden werden.

• and-cli dotnet --restore -wiederherstellen Sie die Dotnet -Lösung
• and-cli dotnet - Backend -Projekt laufend
• and-cli dotnet-test --by-project -Ausführen von Backend-automatisierten Tests
• and-cli dotnet -- --cli test db migrate -Migrieren Sie die Testdatenbank (Reinigen und Wiederherstellen des Projekts, bevor Sie ausgeführt werden. Mit: and-cli dotnet -cRb ).
• and-cli migration --add MigrationName -generiert eine EF-Kerndatenbankmigration basierend auf Code-First-Änderungen
• and-cli migration --run MigrationName -läuft (oder kehrt zu einer angegebenen Migration der EF -Kerndatenbank zurück) aus (oder kehrt sie zurück)
• and-cli webpack - Frontend laufen
• and-cli webpack-test -Ausführen von Frontend-Tests
• and-cli webpack --restore -NPM -Abhängigkeiten für Frontend wiederherstellen
• npm run all-tests alle Testsuiten aus (Backend, funktional, Frontend) und läuft einen Storybook -Build (aus der Wurzel des Repo)
• cd frontend && npm run cypress:open - Functional Test Suite interaktiv ausführen
• cd frontend && npm run cypress:open:working - Funktional Test Suite interaktiv gegen Arbeiten ausführen
• cd frontend && npm run cypress:run - Functional Test Suite ausführen
• cd frontend && npm run cypress:run:working - Functional Test Suite Kopflos ausführen
• cd frontend && npm run test:debug -Startet Web-Socket-Verbindung für einfache, unabhängige interaktive interaktive Debugging https://create-react-app.dev/docs/debugging-tests/

5. Erste Schritte

Stellen Sie die Dotnet -Pakete wieder her (nur zum ersten Mal)

 and-cli dotnet --restore

Stellen Sie die NPM -Knotenmodule wieder her (nur zum ersten Mal)

 and-cli webpack --restore

Starten Sie den Dotnet -Server

 and-cli dotnet

Starten Sie den WebPack -Server

 and-cli webpack

Öffnen Sie Ihren Browser und navigieren Sie zu:

 https://localhost:5001

Dokumentation

Technische Dokumentation

Die technische Dokumentation deckt die Codebasis (dh Muster, Stil und Best Practices), die Softwareentwicklung, das Aufbau und die Bereitstellung des Projekts ab.

• Architektur
• Hintergrundjobs: Hangfeuer
• Ausschnitt
• Codekonventionen
• Entitäten
• Frontend -Architektur
• Git Workflow
• Hangfeuer
• Gemeinsamer Hintergrund -Job -Engine
• Storybook / Kop
• Swagger -Dokumentation

Externe Ressourcen

Externe Ressourcen decken Anforderungen, Architektur, Design und Projektmanagement auf hoher Ebene für das Projekt ab.

• API -Dokumentation
• Jira

Hinzufügen von Dokumentation

• Hier ist unser Dokumentationsstil -Handbuch und unsere Vorlage für den Einstieg.
• Die Dokumentation sollte mit Markdown geschrieben werden und die .md -Erweiterung haben. Bitbucket verfügt über eine Markdown -Syntaxhandbuch als Referenz.
• Informationen zum Schreiben von Dokumenten finden Sie auf dem Schreiben der Dokumente.

Mitwirkende

Vielen Dank an diese wunderbaren Menschen (Emoji -Schlüssel):

Winton Deshong Euen ? ?

Brandon Scott Euen ?

Dylan Gerechtigkeit Euen ?

Stefanie Leitch ?

Dieses Projekt folgt der All-Contributors-Spezifikation. Beiträge jeglicher Art willkommen!