Skip to content

Latest commit

 

History

History
205 lines (151 loc) · 12.3 KB

README.md

File metadata and controls

205 lines (151 loc) · 12.3 KB
Raw

Node.js API Starter Kit

Node.js API Starter Kit is a project template for building Node.js backend applications optimized for serverless infrastructure such as Google Cloud Functions, AWS Lambda, Azure Functions, etc. Use it as an API server for your front-end app.

Features

  • Database first design; auto-generated strongly typed data models (TypeScript)
  • Authentication and authorization using OAuth 2.0 providers (Google, Facebook, GitHub, etc.)
  • Stateless sessions implemented with JWT tokens and a session cookie (compatible with SSR)
  • GraphQL API example, implemented using the code-first development approach
  • Database schema migration, seeds, and REPL shell tooling
  • Transactional emails using Handlebars templates and instant email previews
  • Structured logs and error reporting to Google StackDriver
  • Pre-configured unit testing tooling powered by Jest and Supertest
  • Application bundling with Rollup as an optimization technique for serverless deployments
  • Rebuilds and restarts the app on changes when running locally
  • Pre-configured for local, dev, test, and prod environments
  • The ongoing design and development is supported by these wonderful companies:

    

This project was bootstrapped with Node.js API Starter Kit. Be sure to join our Discord channel for assistance.

Tech Stack

Directory Structure

├──.build — Compiled and bundled output (per Cloud Function)
├──.vscode — VSCode settings including code snippets, recommended extensions etc.
├──api — Cloud Function for handling API requests using GraphQL.js
├──auth — Authentication and session middleware
├──core — Common application modules (email, logging, etc.)
├──db — Database client for PostgreSQL using Knex
├──emails — Email templates for transactional emails using Handlebars
├──env — Environment variables for local, dev, test, and prod
├──migrations — database schema migrations (Cloud SQL, Knex)
├──scripts — Deployment scripts, REPL shell, etc.
├──test — Unit tests and benchmarks
├──views — HTML templates using Handlebars
└── ... — add more cloud functions such as worker, notifications, etc.

Requirements

Getting Started

  • Clone the repo — git clone -o seed https://github.com/kriasoft/node-starter-kit.git.
  • Update environment variables for local, dev, test, and prod environments (./env).
  • Install project dependencies — yarn install
  • Bootstrap PostgreSQL database — yarn db:create
  • Finally, launch the app — yarn start, it will become available at http://localhost:8080.

Use APP_ENV environment variable to execute scripts for different environments, for example:

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

IMPORTANT: Ensure that VSCode is using the workspace versions of TypeScript and ESLint.

Scripts

  • yarn start — Launches the app in development mode on http://localhost:8080
  • yarn build — Compiles and bundles the app for deployment
  • yarn lint — Validate code using ESLint
  • yarn tsc — Validate code using TypeScript compiler
  • yarn test — Run unit tests with Jest, Supertest
  • yarn repl — Connect to the database using Knex REPL shell
  • yarn psql — Connect to the database using PostgreSQL CLI
  • yarn db:create — Create a new database
  • yarn db:version — Check the current version of the database
  • yarn db:migrate — Migrate database schema to the latest version
  • yarn db:rollback — Rollback the latest migration
  • yarn db:seed — Seed database with sample / reference data
  • yarn db:reset — Re-apply the latest DB schema migration file
  • yarn update-types — Generate strongly typed data models from database schema

Optionally set APP_ENV to local (default), dev, test, or prod before running these scripts.

How to Configure 0Auth 2.0 Login Flow

For each 3rd party identity provider that needs to be enabled for your app, you will need to obtain application credentials, often called client ID/secret.

Google

From there on, visiting http://localhost:8080/auth/google (or, opening it in a popup window) would initiate login flow via Google.

Facebook

  • Go to Facebook Developer website
  • Create a new Facebook App, enable Facebook Login for this app
  • Close Quickstart dialog and go straight to the app settings
  • Add http://localhost/auth/facebook/return as the callback URL for the login flow
  • Copy and paste the newly created Facebook App ID and secret to FACEBOOK_APP_ID, FACEBOOK_APP_SECRET variables found in env/.env.* files for each environment that you need.

From there on, visiting http://localhost:8080/auth/facebook (or, opening it in a popup window) would initiate login flow via Facebook.

How to Deploy

The deployment script (yarn deploy) relies on Google Cloud CLI (gcloud) tool that you can download from here. For CI/CD workflows you may need a Docker image like this one.

gcloud auth login — Authorize Google Cloud SDK (CLI) tool to use your Google account.

Create a new GCP project for your app with IDs such as example for production, and example-test for test / QA environments. Ensure that Cloud Build API and Cloud Functions API are enabled in your GCP project's settings here.

Create a Cloud SQL database instance here in the same region where your app needs to be deployed. Using a micro instance of Cloud SQL with 0.6 GB RAM should be OK for testing and low traffic websites.

Ensure that GOOGLE_CLOUD_PROJECT, GOOGLE_CLOUD_REGION, PGDATABASE, PGUSER and the other environment variables are correctly set for the target deployment environment (e.g. /env/.env + /env/.env.prod for production).

Finally, compile and deploy the app by running:

  • yarn build — Compiles the app into the .build folder
  • APP_ENV=<env> yarn db:migrate — Migrates database (schema) to the latest version
  • APP_ENV=<env> yarn deploy — Deploys the app to Google Cloud Functions (GCF)

Where <env> is the target environment, e.g. APP_ENV=prod yarn deploy.

How to Update

  • yarn set version latest — Bump Yarn to the latest version
  • yarn upgrade-interactive — Update Node.js modules (dependencies)
  • yarn pnpify --sdk vscode — Update TypeScript, ESLint, and Prettier settings in VSCode

Backers

              

Related Projects

How to Contribute

Anyone and everyone is welcome to contribute. Start by checking out the list of open issues marked help wanted. However, if you decide to get involved, please take a moment to review the guidelines.

License

Copyright © 2016-present Kriasoft. This source code is licensed under the MIT license found in the LICENSE file.

Made with ♥ by Konstantin Tarkus (@koistya, blog) and contributors.