johnvalle / meldcx-backend-test

Express API Starter

Includes API Server utilities:

• morgan
  • HTTP request logger middleware for node.js
• helmet
  • Helmet helps you secure your Express apps by setting various HTTP headers. It's not a silver bullet, but it can help!
• dotenv
  • Dotenv is a zero-dependency module that loads environment variables from a .env file into process.env

Development utilities:

• nodemon
  • nodemon is a tool that helps develop node.js based applications by automatically restarting the node application when file changes in the directory are detected.
• eslint
  • ESLint is a tool for identifying and reporting on patterns found in ECMAScript/JavaScript code.
• mocha
  • ☕️ Simple, flexible, fun JavaScript test framework for Node.js & The Browser ☕️
• supertest
  • HTTP assertions made easy via superagent.

Setup

npm install

Sample .env

NODE_ENV=development
PORT=3000
FOLDER=/absolute/path/to/public/uploads
PROVIDER=local or google
CONFIG=/absolute/path/to/google/service/account
BUCKET_NAME=cloud-storage-bucket-name
# the following details can be acquired from firebase config
FIREBASE_API_KEY
FIREBASE_AUTH_DOMAIN
FIREBASE_PROJECT_ID
FIREBASE_BUCKET
FIREBASE_SENDER_ID
FIREBASE_APP_ID

Lint

npm run lint

Test

npm run test

Development

npm run dev