Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hueter/docker-node-express-boilerplate

Boilerplate for quickly bootstrapping production-ready RESTful APIs / microservices
https://github.com/hueter/docker-node-express-boilerplate

api boilerplate docker es6 expressjs microservice mongodb mongoose nginx nodejs restful-api

Last synced: 2 months ago
JSON representation

Boilerplate for quickly bootstrapping production-ready RESTful APIs / microservices

Awesome Lists containing this project

README 

        
# RESTful API Server Boilerplate



## Featuring Docker, Node, Express, MongoDB, Mongoose, & NGINX



![Tech Logos](./logos.png)



## License & Purpose



MIT License. This is something I've used in production before with success that I found useful for quickly bootstrapping RESTful APIs. You can fork and clone and take this apart without giving me any credit for anything. If you like it, you can star the repo ⭐️ or follow me on GitHub.



Feel free to make an issue or PR if you want to suggest ideas / fixes.



## About



This configuration is a backend [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer) boilerplate with the following pieces:



- [Docker](https://www.docker.com/) as the container service to isolate the environment.

- [Node.js](https://nodejs.org/en/) (Long-Term-Support Version) as the run-time environment to run JavaScript.

- [Express.js](https://expressjs.com/) as the server framework / controller layer

- [MongoDB](https://www.mongodb.com/) as the database layer

- [Mongoose](https://mongoosejs.com/) as the "ODM" / model layer

- [NGINX](https://docs.nginx.com/nginx/admin-guide/content-cache/content-caching/) as a proxy / content-caching layer



## How to Install & Run



You will need to first download and install [Docker Desktop](https://www.docker.com/products/docker-desktop) or [Linux equivalent](https://docs.docker.com/install/linux/docker-ce/ubuntu/).



0.  Fork/Clone the repo

1.  Run `docker-compose up` to start three containers:

    - the MongoDB database container

    - the Node.js app container

    - the NGINX proxy container

1.  Server is accessible at `http://localhost:8080` if you have Docker for Windows or Mac. Use `http://localhost` without specifying the port to hit the NGINX proxy. On Linux, you may need to hit the IP Address of the docker-machine rather than `localhost` (port rules are the same.)



## How to Run Tests



Currently, tests are run outside of the Docker container (unfortunately for now). The tests use an in-memory version of MongoDB. You should be able to run `npm install` followed by `npm test` to run everything (assuming you have the LTS version of Node installed on your machine).



## App Structure



- the boilerplate entity is called "Thing" and all the routes are based on the thing resource. When you want to start building a real API, you can probably just do a global find and replace for thing, but mind the case-sensitivity.

- most folders have an `index.js` which simply exports the contents of all the files in those folders. This is to make importing things around the app slightly easier, since you can just `require` the folder name and destructure the functions you are looking for. Check out [this part of the Node.js docs](https://nodejs.org/api/modules.html#modules_folders_as_modules) for more info.



**\_\_tests\_\_**



- this folder contains unit and integration tests both run using `npm test` which in turn uses [Jest](https://jestjs.io/)



**./app**



- `handlers` are Express.js route handlers that have `request`, `response`, and `next` parameters.

- `helpers` are raw JS "classes" and utility functions for use across the app

- `models` are [Mongoose schema](https://mongoosejs.com/docs/guide.html) definitions and associated models

- `routers` are RESTful route declarations using [express.Router module](https://expressjs.com/en/guide/routing.html) that utilize the functions in `handlers`

- `schemas` are [JSONSchema](https://json-schema.org/understanding-json-schema/index.html) validation schemas for creating or updating a Thing. Pro-tip: use [JSONSchema.net](https://jsonschema.net/) to generate schemas based on examples for you.

- `app.js` is what builds and configures the express app

- `config.js` is the app-specific config that you will want to customize for your app

- `index.js` is the entrypoint that actually starts the Express server



**./config**



- config contains NGINX proxy configuration, the production pm2 configuration (the process-runner of choice), and the Jest configuration to run MongoDB in memory