diff --git a/README.md b/README.md index a781c62..fa5a0c8 100644 --- a/README.md +++ b/README.md @@ -22,23 +22,26 @@ It makes the following modifications: - Configured for Travis CI (continuous integration), Coveralls (code coverage), GreenKeeper (automated dependency management), and Semantic Release (automated versioning). +- 'Production' environment is targeted for packaging as a Docker container. + ## Features This project covers basic necessities of most APIs. * Authentication (passport & jwt) * Database (mongoose) * Testing (mocha) * Doc generation with apidoc -* linting using standard +* Linting using standard +* Packaged as a Docker container ## Requirements -* node __^8.9.4__ -* npm __^5.7.1__ +* node __^10.15.1__ +* npm __^6.7.0__ ## Installation ```bash -git clone https://github.com/christroutner/babel-free-koa2-api-boilerplate.git +git clone https://github.com/christroutner/koa-api-boilerplate/tree/docker ``` ## Structure @@ -68,6 +71,8 @@ git clone https://github.com/christroutner/babel-free-koa2-api-boilerplate.git * `npm run dev` Start server on dev mode with nodemon * `npm run docs` Generate API documentation * `npm test` Run mocha tests +* `docker-compose build` Build a 'production' Docker container +* `docker-compose up` Run the docker container ## Documentation API documentation is written inline and generated by [apidoc](http://apidocjs.com/). diff --git a/production/Dockerfile b/production/Dockerfile index f6adedf..bd7e922 100644 --- a/production/Dockerfile +++ b/production/Dockerfile @@ -2,7 +2,7 @@ # #IMAGE BUILD COMMANDS -# ct-base-ubuntu = ubuntu 18.04 + nodejs +# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS FROM christroutner/ct-base-ubuntu MAINTAINER Chris Troutner