Téléchargement node starter kit - Téléchargement du code source node starter kit

node starter kit

Données du site Web

1.0.0

Télécharger

Kit de démarrage de l'API Node.js

Le kit de démarrage de l'API Node.js est un modèle de projet pour créer des applications backend Node.js optimisées pour l'infrastructure sans serveur telles que les fonctions Google Cloud, AWS Lambda, Azure Fonctions, etc. Utilisez-le comme serveur API pour votre application frontale.

Caractéristiques

First de conception de la base de données; Modèles de données fortement dactylographiés générés automatiquement (typescript)
Authentification et autorisation à l'aide des fournisseurs OAuth 2.0 (Google, Facebook, Github, etc.)
Des séances sans état implémentées avec des jetons JWT et un cookie de session (compatible avec SSR)
Exemple de l'API GraphQL, implémenté à l'aide de l'approche de développement de Code First
Migration de schéma de base de données, graines et outils de coquille
Emails transactionnels à l'aide de modèles de guidon et de prévisualisation des e-mails instantanés
Les journaux structurés et les rapports d'erreur à Google Stackdriver
Outillage de test d'unité préconfiguré alimenté par la plaisanterie et le supertest
Application Bundling avec Rollup comme technique d'optimisation pour les déploiements sans serveur
Reconstruise et redémarre l'application sur les modifications lors de l'exécution localement
Pré-configuré pour les environnements local , dev , test et prod
La conception et le développement en cours sont soutenus par ces merveilleuses entreprises:

Ce projet a été enraciné avec le kit de démarrage de l'API Node.js. Assurez-vous de rejoindre notre canal Discord pour obtenir de l'aide.

Pile technologique

Node.js v14, gestionnaire de package de fils, TypeScript, Babel, Rollup, Eslint, plus joli, plaisantant
PostgreSQL, GraphQL.JS, Knex, Express, Nodemailer, Modèles de messagerie, guidon, simple OAuth2

Structure de répertoire

├── .build
├── .vscode
├── Fonction api - Cloud pour gérer les demandes d'API à l'aide de graphql.js
├── auth - Authentification et middleware de session
├── core - Modules d'application courants (e-mail, journalisation, etc.)
├── db - Client de la base de données pour PostgreSQL à l'aide de Knex
├── emails - modèles de messagerie pour les e-mails transactionnels à l'aide du guidon
├── env - Variables d'environnement pour local , dev , test et prod
├── migrations - Migrations de schéma de base de données (Cloud SQL, Knex)
├── - scripts de déploiement, coquille scripts red, etc.
├── test - tests unitaires et références
├── views - Modèles HTML utilisant le guidon
└── ... - Ajouter plus de fonctions de nuage telles que worker , notifications , etc.

Exigences

Node.js v14, gestionnaire de packages de fils
Instance locale ou distante de PostgreSQL (voir postgres.app, Google Cloud SQL)
Vs éditeur de code avec des extensions recommandées

Commencer

Clone The Repo - git clone -o seed https://github.com/kriasoft/node-starter-kit.git .
Mettez à jour les variables d'environnement pour les environnements local , dev , test et prod ( ./env ).
Installer les dépendances du projet - yarn install
Base de données Bootstrap Postgresql - yarn db:create
Enfin, lancez l'application - yarn start , il sera disponible sur http: // localhost: 8080.

Utilisez la variable d'environnement APP_ENV pour exécuter des scripts pour différents environnements, par exemple:

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

IMPORTANT : Assurez-vous que VScode utilise les versions d'espace de travail de TypeScript et Eslint.

Scripts

yarn start - Lance l'application en mode développement sur http://localhost:8080
yarn build - compile et regroupe l'application pour le déploiement
yarn lint - Valider le code à l'aide d'Eslint
yarn tsc - Valider le code à l'aide du compilateur TypeScript
yarn test - Exécutez des tests unitaires avec une plaisanterie, Supertest
yarn repl - Connectez-vous à la base de données à l'aide de Shell Knex REP
yarn psql - Connectez-vous à la base de données à l'aide de PostgreSQL CLI
yarn db:create - Créer une nouvelle base de données
yarn db:version - Vérifiez la version actuelle de la base de données
yarn db:migrate - Migrer le schéma de base de données vers la dernière version
yarn db:rollback - Rollback La dernière migration
yarn db:seed - base de données de graines avec des données d'échantillon / référence
yarn db:reset - réappliquez le dernier fichier de migration de schéma de base de données
yarn update-types - Générez des modèles de données fortement typés à partir du schéma de base de données

Définissez éventuellement APP_ENV sur local (par défaut), dev , test ou prod avant d'exécuter ces scripts.

Comment configurer le flux de connexion 0Auth 2.0

Pour chaque fournisseur d'identité tierce qui doit être activé pour votre application, vous devrez obtenir des informations d'identification d'application, souvent appelées ID / Secret client.

Google

Aller à Google Cloud Console
Créer un nouveau projet GCP
Configurer l'écran OAuth Concent
Créez un client OAuth 2.0 avec http://localhost/auth/google/return comme URL de rappel
Mettez à jour GOOGLE_CLIENT_ID , GOOGLE_CLIENT_SECRET Environment Variables trouvées dans ./env/.env.* pour chaque environnement dont vous avez besoin.

À partir de là, visiter http://localhost:8080/auth/google (ou, l'ouvrir dans une fenêtre contextuelle) initierait le flux de connexion via Google.

Facebook

Allez sur Facebook Developer Site Web
Créez une nouvelle application Facebook, activez la connexion Facebook pour cette application
Fermez la boîte de dialogue QuickStart et allez directement aux paramètres de l'application
Ajouter http://localhost/auth/facebook/return comme URL de rappel pour le flux de connexion
Copiez et collez l'ID d'application Facebook nouvellement créé et secret sur FACEBOOK_APP_ID , FACEBOOK_APP_SECRET Variables trouvées dans env/.env.* Fichiers pour chaque environnement dont vous avez besoin.

À partir de là, visiter http://localhost:8080/auth/facebook (ou, l'ouvrir dans une fenêtre contextuelle) initierait le flux de connexion via Facebook.

Comment déployer

Le script de déploiement ( yarn deploy ) s'appuie sur l'outil Google Cloud CLI ( gcloud ) que vous pouvez télécharger à partir d'ici. Pour les workflows CI / CD, vous avez peut-être besoin d'une image Docker comme celle-ci.

gcloud auth login - Autoriser l'outil SDK Google Cloud (CLI) pour utiliser votre compte Google.

Créez un nouveau projet GCP pour votre application avec des ID tels que example de production et example-test pour les environnements de test / QA. Assurez-vous que l'API Cloud Build et les fonctions cloud sont activées dans les paramètres de votre projet GCP ici.

Créez ici une instance de base de données SQL Cloud dans la même région où votre application doit être déployée. L'utilisation d'une micro-instance de Cloud SQL avec 0,6 Go de RAM devrait être OK pour les tests et les sites Web à faible trafic.

Assurez-vous que GOOGLE_CLOUD_PROJECT , GOOGLE_CLOUD_REGION , PGDATABASE , PGUSER et les autres variables d'environnement sont correctement définies pour l'environnement de déploiement cible (par exemple /env/.env + /env/.env.prod pour la production).

Enfin, compilez et déployez l'application en exécutant:

yarn build - compile l'application dans le dossier .build
APP_ENV=<env> yarn db:migrate - migrer la base de données (schéma) vers la dernière version
APP_ENV=<env> yarn deploy - déploie l'application sur Google Cloud Fonctions (GCF)

Lorsque <env> est l'environnement cible, par exemple APP_ENV=prod yarn deploy .

Comment mettre à jour

yarn set version latest - Bump Yarn à la dernière version
yarn upgrade-interactive - Mettre à jour les modules Node.js (dépendances)
yarn pnpify --sdk vscode - Mettez à jour les paramètres de type TypeScript, Eslint et plus jolis dans vScode

Bailleurs de fonds

Projets connexes

Kit de démarrage de l'API GraphQL - modèle monorepo, préconfiguré avec TypeScript, GraphQL, React et Relay.
Kit React Starter - modèle de projet, préconfiguré avec WebPack et réagir

Comment contribuer

Tout le monde et tout le monde est invité à contribuer. Commencez par consulter la liste des problèmes ouverts marqués l'aide recherchée. Cependant, si vous décidez de vous impliquer, veuillez prendre un moment pour examiner les directives.