mirror of
https://github.com/Permissionless-Software-Foundation/x402-base-facilitator.git
synced 2026-09-21 16:52:01 -07:00
feat(docker): Production builds to a Docker container
This commit is contained in:
@@ -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).
|
- 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
|
## Features
|
||||||
This project covers basic necessities of most APIs.
|
This project covers basic necessities of most APIs.
|
||||||
* Authentication (passport & jwt)
|
* Authentication (passport & jwt)
|
||||||
* Database (mongoose)
|
* Database (mongoose)
|
||||||
* Testing (mocha)
|
* Testing (mocha)
|
||||||
* Doc generation with apidoc
|
* Doc generation with apidoc
|
||||||
* linting using standard
|
* Linting using standard
|
||||||
|
* Packaged as a Docker container
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
* node __^8.9.4__
|
* node __^10.15.1__
|
||||||
* npm __^5.7.1__
|
* npm __^6.7.0__
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
```bash
|
```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
|
## 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 dev` Start server on dev mode with nodemon
|
||||||
* `npm run docs` Generate API documentation
|
* `npm run docs` Generate API documentation
|
||||||
* `npm test` Run mocha tests
|
* `npm test` Run mocha tests
|
||||||
|
* `docker-compose build` Build a 'production' Docker container
|
||||||
|
* `docker-compose up` Run the docker container
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
API documentation is written inline and generated by [apidoc](http://apidocjs.com/).
|
API documentation is written inline and generated by [apidoc](http://apidocjs.com/).
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
#
|
#
|
||||||
|
|
||||||
#IMAGE BUILD COMMANDS
|
#IMAGE BUILD COMMANDS
|
||||||
# ct-base-ubuntu = ubuntu 18.04 + nodejs
|
# ct-base-ubuntu = ubuntu 18.04 + nodejs v10 LTS
|
||||||
FROM christroutner/ct-base-ubuntu
|
FROM christroutner/ct-base-ubuntu
|
||||||
MAINTAINER Chris Troutner <chris.troutner@gmail.com>
|
MAINTAINER Chris Troutner <chris.troutner@gmail.com>
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user