NodeJS starter setup.

.env.docker

@@ -1,15 +1,17 @@
 # Application
-APP_NAME='Express API ES6 Starter'
+APP_NAME='Node JS Starter'
 APP_VERSION='1.0.0'
 APP_PORT='8848'
 APP_HOST='0.0.0.0'
 
 # Log
-LOGGING_DIR='logs'
-LOGGING_LEVEL='debug'
+LOG_DIR='logs'
+LOG_LEVEL='debug'
+LOG_RETENTION_PERIOD=''
+ENABLE_FILE_LOG_TRANSPORT='TRUE'
 
 # Database
-DB_CLIENT='pg'
+DB_CLIENT='mysql'
 
 # App Environment
 DB_PORT='5432'

.env.example

@@ -1,22 +1,31 @@
 # Application
-APP_NAME='Express API ES6 Starter'
+APP_NAME='Node JS Starter'
 APP_VERSION='1.0.0'
 APP_PORT='8848'
 APP_HOST='127.0.0.1'
 
 # Log
+LOG_DIR='logs'
 LOG_LEVEL='debug'
+LOG_RETENTION_PERIOD=''
+ENABLE_FILE_LOG_TRANSPORT='TRUE'
 
 # Database
-DB_CLIENT='pg'
+DB_CLIENT='mysql'
+
 
 # App Environment
-DB_PORT='5432'
+DB_PORT='3306'
 DB_HOST='localhost'
 DB_NAME='express'
 DB_USER='username'
 DB_PASSWORD='password'
 
+
+# Authenication parameters
+AUTH_URL='http://localhost:5000/'
+AUTH_CLIENT_ID='secret-client-id'
+
 # Sentry
 # https://docs.sentry.io/quickstart
 SENTRY_DSN=''

.prettierrc

@@ -1,3 +1,4 @@
 tabWidth: 2
 printWidth: 120
 singleQuote: true
+arrowParens: avoid

.travis.yml

@@ -6,29 +6,28 @@ node_js:
   - lts/dubnium
 
 services:
-  - postgresql
+  - mysql
 
 branches:
   only:
     - master
 
 env: >
   NODE_ENV=test
-  APP_NAME='Express API ES6 Starter'
+  APP_NAME='Node JS Starter'
   APP_VERSION='1.0.0'
   TEST_APP_PORT='9945'
-  TEST_DB_NAME='express_test'
+  TEST_DB_NAME='app_test'
   TEST_DB_PASSWORD=''
-  TEST_DB_PORT='5432'
-  TEST_DB_USER='postgres'
+  TEST_DB_PORT='3306'
+  TEST_DB_USER='mysql'
 
 before_install:
   - curl -o- -L https://yarnpkg.com/install.sh | bash
   - export PATH="$HOME/.yarn/bin:$PATH"
 
 before_script:
   - cp .env.example .env
-  - psql -c 'create database express_test;' -U postgres
   - yarn migrate
 
 script:

README.md

@@ -37,27 +37,6 @@ Example,
     $ yarn make:migration create_tags_table
     $ yarn make:seeder 02_insert_tags
 
-## Using Docker
-
-### Using docker-compose
-
-Use [docker-compose](https://docs.docker.com/compose/) to quickly bring up a stack with pre-configured Postgres database container. Data is ephemeral and containers will disappear when stack is removed.
-
-Specific configuration for Docker is in `.env.docker`
-
-- `0.0.0.0` as `$APP_HOST` to expose app on Docker network interface
-- Pre-configured Postgres settings - can be updated to point to another Postgres host
-
-Bring up stack,
-
-    $ docker-compose up
-
-Navigate to http://localhost:8848/api-docs/ to verify application is running from docker.
-
-Bring down stack,
-
-    $ docker-compose down
-
 ### Multi-stage docker builds
 
 There are multiple build targets available for different stages. These images can be used to deploy or run jobs in different container based cloud infrastructure like Kubernetes, AWS ECS, Fargate, GCP Cloud Run etc.
@@ -100,4 +79,3 @@ To run the tests you need to create a separate test database. Don't forget to up
 Run tests with coverage.
 
     $ yarn test:coverage
-

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "express-api-es6-starter",
+  "name": "@leapfrogtechnology/nodejs-starter",
   "version": "1.0.0",
-  "description": "Express API ES6 Starter",
+  "description": "NodeJS Starter",
   "scripts": {
     "start": "node dist",
     "prestart": "yarn build",
@@ -47,10 +47,10 @@
   "dependencies": {
     "@hapi/boom": "^9.1.0",
     "@hapi/joi": "^17.1.1",
+    "@leapfrogtechnology/async-store": "^1.2.0",
     "@sentry/node": "^5.15.0",
+    "axios": "^0.19.2",
     "body-parser": "^1.19.0",
-    "bookshelf": "^1.1.0",
-    "bookshelf-virtuals-plugin": "^0.1.1",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
     "dotenv": "^8.2.0",
@@ -60,7 +60,7 @@
     "knex": "^0.20.12",
     "lodash": "^4.17.13",
     "morgan": "^1.10.0",
-    "pg": "^7.18.2",
+    "mysql": "^2.18.1",
     "serve-favicon": "^2.5.0",
     "swagger-jsdoc": "^3.5.0",
     "swagger-ui-dist": "^3.25.0",

src/auth/index.js

@@ -0,0 +1,70 @@
+import * as store from '@leapfrogtechnology/async-store';
+
+import { http } from '../utils/http';
+import TokenError from '../errors/token';
+
+/**
+ * Extract token from headers in http request.
+ *
+ * @param {Object} headers
+ * @returns {Object}
+ */
+function extractTokenFromHeaders(headers = {}) {
+  const { authorization = '' } = headers;
+
+  const [tokenType, token] = authorization.split(' ').filter(Boolean);
+
+  if (tokenType !== 'Bearer' || !token) {
+    return {
+      ok: false,
+    };
+  }
+
+  return {
+    token,
+  };
+}
+
+/**
+ * Fetch user from auth server using token.
+ *
+ * @param {String} token
+ * @throws {NetworkError}
+ * @returns {Promise}
+ */
+async function fetchUserByToken(token) {
+  const { data } = await http.get(`${process.env.AUTH_URL}/userinfo`, {
+    headers: {
+      accessToken: token,
+      clientId: process.env.AUTH_CLIENT_ID,
+    },
+  });
+
+  return data;
+}
+
+/**
+ * Validate token received in header.
+ *
+ * @param {Object} req
+ * @param {Object} res
+ * @param {Object} next
+ */
+async function authenticateUser(req, res, next) {
+  try {
+    const { ok, token } = extractTokenFromHeaders(req.headers);
+
+    if (!ok) {
+      throw new TokenError('Invalid token');
+    }
+
+    const user = await fetchUserByToken(token);
+
+    store.set(user);
+    next();
+  } catch (err) {
+    next(err);
+  }
+}
+
+export default authenticateUser;

src/controllers/user.js

@@ -0,0 +1,37 @@
+import HttpStatus from 'http-status-codes';
+
+import * as userService from '../services/user';
+
+/**
+ * Get all users.
+ *
+ * @param {Object} req
+ * @param {Object} res
+ * @param {Function} next
+ */
+export async function fetch(req, res, next) {
+  try {
+    const data = await userService.fetch();
+
+    res.json({ data });
+  } catch (err) {
+    next(err);
+  }
+}
+
+/**
+ * Create a new user.
+ *
+ * @param {Object} req
+ * @param {Object} res
+ * @param {Function} next
+ */
+export async function create(req, res, next) {
+  try {
+    const data = await userService.create();
+
+    res.status(HttpStatus.CREATED).json({ data });
+  } catch (err) {
+    next(err);
+  }
+}