iensu / express-server-js-template

An Express server template implemented in Javascript

Node.JS Express server template

A simple Express server template which comes with the following features:

• Express server
• Testing using Mocha
• Logging using Winston
• Optional API protection using an API_KEY
• Configuration via environment variables
• /liveness endpoint for liveness/health check
• Code linting using Eslint
• Code formatting using Prettier
• NPM scripts:
  • start - Start the application
  • start:dev - Start a server watching for code changes
  • test - Run tests and linter
  • test:dev - Run tests and watch for code changes

How to use

1. Clone the project:

   $ git clone https://github.com/iensu/express-server-js-template my-project-name

2. Remove the Git history:

   $ cd my-project-name
   $ rm -rf .git

3. Re-initialize git:

   $ git init

4. Update the project name field in package.json, package-lock.json and change the author field.
5. Make an initial commit

   $ git commit -am "Initial commit"

Acknowledgements

This project is a grateful recipient of the Futurice Open Source sponsorship program.