generator-api-express-docker

An express template suiting my needs and maybe yours.

What you'll get

A minimalist express app with:

• winston for logging
• babel for latest JS features
• eslint with airbnb rules
• nodemon to autorestart the server on file change

To launch your server for development

yarn docker

The src directory is mounted inside the docker image, so any change to this directory restart the server. At each restart, eslint is triggered and babel-node converts js files. You'll only need to relaunch the commande if you add dependencies to your package.json.

For production the default command inside the Dockerfile is

yarn start

Which use babel to convert js files inside the dist directory, and launch dist/app.js with the default node binary. By default the Docker image is launched with this command.

Installation

You'll need Docker and yarn to fully appreciate this template.

Then, install Yeoman and generator-api-express-docker using yarn or npm (we assume you have pre-installed node.js).

yarn global add yo
yarn global add generator-api-express-docker

or

npm install -g yo
npm install -g generator-api-express-docker

Then generate your new project:

yo node-4-me

Next

• Add Jest
• Use generator-license
• Add basic tests that run inside a Docker image
• Add some tests for the generator
• Add Winston console colors 🤗
• Better README
• Add Travis.ci
• Use Yarn cache to speed up Docker build
• Add nsp
• Add WebStorm meta ?
• Add Flow ?

License

MIT © Pierre-Etienne Cherière