Node-Docker-dev-env
Small, almost minimal, boilerplate to learn how to set up a local Node.js development enviroment inside a container. It uses Docker to create a container in the local machine with Node Carbon.
Why?
Every developer has had awful experiences with differing enviroments in different systems (staging and prod, one machine and another). Working with docker in your local machine looks to minimize this. Setting up your enviroment from an existing project using Docker and Docker-Compose works like charm, it may even be a matter of minutes!
By using docker-compose and taking advantage of docker's volumes, development can be almost identical to local development but with much more benefits.
What does it do?
As it was mentioned before, this is just an example to see the posibilities and how to start with local development with docker. It's exposing a extremely basic todo app backend (just 2 endpoints, get all an create).
The main purpose beyond the running of a node process, was also to show how to connect to a database using docker-compose.
Usage
Just run docker-compose up --build and the container will be up and running.
Configuration
The docker-compose.yml and Dockerfile expose the port 8080 and create a volume of the root folder, as they are. If any of this needs to be changed, the following lines need to be changed:
XXXX: 8080below ports indocker-compose.yml. XXXX is the local machine port number that you want to use- ./:/app to change which folder will be set as a volume.
./represents the root folder in your machine and/apprepresents the folder inside the container that will be set as a volume.
Dependencies
Production
- sequelize: ORM to handle the database access independently of the database used
- pg: adapter of postgress to be used with sequelize
- express: almost de-facto for setting an API
Development
- chai, mocha and sinoi: one of the best combinations for testing a node.js application
- nodemon: To make the development experience better, it restarts the server anytime a field is changed.