Download node starter kit - node starter kit Quellcode Download

node starter kit

Website-Daten

1.0.0

Herunterladen

Node.js API Starter Kit

Node.js API Starter Kit ist eine Projektvorlage zum Erstellen von Node.JS-Backend-Anwendungen, die für serverlose Infrastruktur optimiert sind, wie z.

Merkmale

Datenbank Erstes Design; Automatisch generierte stark typisierte Datenmodelle (TypeScript)
Authentifizierung und Autorisierung mit OAuth 2.0 -Anbietern (Google, Facebook, GitHub usw.)
Vorstandlose Sitzungen mit JWT -Token und einem Sitzungs -Cookie (kompatibel mit SSR)
Beispiel für GraphQL-API, implementiert mit dem Code-ersten Entwicklungsansatz
Datenbankschema -Migration, Saatgut und Reply -Shell -Werkzeug
Transaktions -E -Mails mithilfe von Lenkervorlagen und sofortigen E -Mail -Voransichten
Strukturierte Protokolle und Fehlerberichterstattung an Google Stackdriver
Vorkonfiguriertes Initi-Testwerkzeug, das von Scherz und Supertest betrieben wird
Anwendungsbündelung mit Rollup als Optimierungstechnik für serverlose Bereitstellungen
Umbau und startet die App bei Änderungen neu, wenn Sie lokal ausgeführt werden
Vorkonfiguriert für local , dev , test und prod Umgebungen
Das laufende Design und die Entwicklung werden von diesen wunderbaren Unternehmen unterstützt:

Dieses Projekt wurde mit Node.js API Starter Kit strapdiert. Stellen Sie sicher, dass Sie sich unserem Discord -Kanal anschließen, um Hilfe zu erhalten.

Tech Stack

Node.js v14, Garnpaketmanager, TypeScript, Babel, Rollup, Eslint, Schöner, Scherz
PostgreSQL, Graphql.js, Kne

Verzeichnisstruktur

├── .build - kompilierte und gebündelte Ausgabe (pro Wolkenfunktion)
├── .vscode - VSCODE -Einstellungen einschließlich Code -Snippets, empfohlene Erweiterungen usw.
├── api - Cloud -Funktion zum Umgang mit API -Anforderungen mithilfe von GraphQL.js
├── auth und Sitzung Middleware
├── core - gemeinsame Anwendungsmodule (E -Mail, Protokollierung usw.)
├── db - Datenbank Client für PostgreSQL mit Knex
├── emails - E -Mail -Vorlagen für Transaktions -E -Mails mithilfe von Lenker
├── env für local , dev , test und prod
├── migrations - Datenbankschema -Migrationen (Cloud SQL, KNEX)
├── scripts - Bereitstellungsskripte, Reply Shell usw.
├── test - Unit -Tests und Benchmarks
├── views - HTML -Vorlagen mit Lenker mit Lenker
└── ... - Fügen Sie weitere Cloud -Funktionen wie worker , notifications usw. hinzu.

Anforderungen

Node.js v14, Garnpaketmanager
Lokale oder Remote -Instanz von PostgreSQL (siehe Postgres.app, Google Cloud SQL)
VS -Code -Editor mit empfohlenen Erweiterungen

Erste Schritte

Klon The Repo- git clone -o seed https://github.com/kriasoft/node-starter-kit.git .
Aktualisieren Sie Umgebungsvariablen für local , dev , test und prod -Umgebungen ( ./env ).
Projektabhängigkeiten installieren - yarn install
Bootstrap postgresql -Datenbank - yarn db:create
Schließlich starten Sie die App - yarn start , sie wird unter http: // localhost: 8080 erhältlich.

Verwenden Sie die Umgebungsvariable APP_ENV , um Skripte für verschiedene Umgebungen auszuführen, z. B.:

 $ APP_ENV=test yarn db:migrate
$ APP_ENV=test yarn start

Wichtig : Stellen Sie sicher, dass VSCODE die Arbeitsbereicheversionen von TypeScript und Eslint verwendet.

Skripte

yarn start - Startet die App im Entwicklungsmodus unter http://localhost:8080
yarn build - kompiliert und bündelt die App für die Bereitstellung
yarn lint - Code mit Eslint validieren
yarn tsc - Validieren Sie den Code mit dem TypeScript -Compiler
yarn test - Führen Sie Einheitstests mit Scherz, Supertest aus
yarn repl - Verbindung zur Datenbank mit der Knex Repl Shell herstellen
yarn psql - Verbindung zur Datenbank mit PostgreSQL CLI herstellen
yarn db:create - Erstellen einer neuen Datenbank
yarn db:version - Überprüfen Sie die aktuelle Version der Datenbank
yarn db:migrate - Das Datenbankschema migrieren in die neueste Version
yarn db:rollback - Rollback Die neueste Migration
yarn db:seed -Saatgut -Datenbank mit Beispiel- / Referenzdaten
yarn db:reset -Stellen Sie die neueste DB-Schema-Migrationsdatei erneut an
yarn update-types -Erzeugen Sie stark typisierte Datenmodelle aus dem Datenbankschema

Setzen Sie optional APP_ENV auf local (Standard), dev , test oder prod bevor Sie diese Skripte ausführen.

So konfigurieren Sie 0Auth 2.0 Anmeldefluss

Für jeden Identitätsanbieter der Drittanbieter, der für Ihre App aktiviert werden muss, müssen Sie Anwendungsanmeldeinformationen erhalten, die häufig als Client -ID/Secret bezeichnet werden.

Google

Gehen Sie zur Google Cloud Console
Erstellen Sie ein neues GCP -Projekt
Konfigurieren Sie OAuth Concent -Bildschirm
Erstellen Sie den OAuth 2.0 -Client mit http://localhost/auth/google/return als Callback -URL zurück
Aktualisieren Sie GOOGLE_CLIENT_ID , GOOGLE_CLIENT_SECRET -Umgebungsvariablen in ./env/.env.* Für jede von Ihnen benötigte Umgebung.

Von dort aus besuchen Sie http://localhost:8080/auth/google (oder das Öffnen in einem Popup -Fenster) den Anmeldefluss über Google einleiten.

Facebook

Besuchen Sie die Facebook -Entwickler -Website
Erstellen Sie eine neue Facebook -App und aktivieren Sie Facebook Login für diese App
Schließen Sie das Dialogfeld "QuickStart" und gehen Sie direkt zu den App -Einstellungen
Fügen Sie http://localhost/auth/facebook/return als Callback -URL für den Anmeldebiet hinzu
Kopieren und fügen Sie die neu erstellte Facebook -App -ID und heimlich auf FACEBOOK_APP_ID , FACEBOOK_APP_SECRET Variablen in env/.env.*

Von dort aus besuchen Sie http://localhost:8080/auth/facebook (oder das Öffnen in einem Popup -Fenster) den Anmeldefluss über Facebook einleiten.

Bereitstellung

Das Bereitstellungsskript ( yarn deploy ) basiert auf Google Cloud CLI ( gcloud ) -Tool, das Sie hier herunterladen können. Für CI/CD -Workflows benötigen Sie möglicherweise ein Docker -Bild wie dieses.

gcloud auth login - Autorisieren Sie das Google Cloud SDK (CLI) Tool, um Ihr Google -Konto zu verwenden.

Erstellen Sie ein neues GCP-Projekt für Ihre App mit IDs wie example für die Produktion und example-test für Test- / QA-Umgebungen. Stellen Sie hier sicher, dass die API für Cloud -Build -API- und Cloud -Funktionen in den Einstellungen Ihres GCP -Projekts hier aktiviert ist.

Erstellen Sie hier in derselben Region, in der Ihre App bereitgestellt werden muss, eine Cloud -SQL -Datenbankinstanz. Die Verwendung einer Micro -Instanz von Cloud SQL mit 0,6 GB RAM sollte für Tests und Websites mit geringem Verkehr in Ordnung sein.

Stellen Sie sicher, dass GOOGLE_CLOUD_PROJECT , GOOGLE_CLOUD_REGION , PGDATABASE , PGUSER und die anderen Umgebungsvariablen für die Zielbereitungsumgebung (z. B. /env/.env + /env/.env.prod für die Produktion) korrekt eingestellt sind.

Schließlich kompilieren und bereitstellen Sie die App durch Ausführen:

yarn build - Kompiliert die App in den .build -Ordner
APP_ENV=<env> yarn db:migrate - Migrats Datenbank (Schema) in die neueste Version
APP_ENV=<env> yarn deploy - Bereitstellen die App für Google Cloud -Funktionen (GCF).

Wobei <env> die Zielumgebung ist, z. B. APP_ENV=prod yarn deploy .

So aktualisieren Sie

yarn set version latest - Bump Yarn zur neuesten Version
yarn upgrade-interactive -Update Node.js Module (Abhängigkeiten)
yarn pnpify --sdk vscode -Aktualisieren Sie TypeScript-, Eslint- und schönere Einstellungen in VSCODE

Unterstützer

Wie man beiträgt

Jeder und jeder ist eingeladen, einen Beitrag zu leisten. Überprüfen Sie zunächst die Liste der offenen Probleme, die mit Hilfe von HILFE GUT MEGELEMENDE AUSGABEN. Wenn Sie sich jedoch für ein Engagement entscheiden, nehmen Sie sich bitte einen Moment Zeit, um die Richtlinien zu überprüfen.