starter-nodejs

Boilerplate code to kick-start projects in Node.js, includes an HTTP layer (Express), database layer (Sequelize), job queue (Bull) and task scheduler (node-schedule) along with a Dockerfile for production and docker-compose config for development.

In addition, it also includes CI pipelines configuration to build and publish Docker images for major hosted CI services including Azure DevOps, Bitbucket Pipelines, Github Actions and Travis CI.

What's included?

• Bull job queue
• Cron-style task scheduler
• Elasticsearch server (running on 9200 and 9300 ports)
• Express app (running on 3000 port)
• MailHog server (running on 1025 and 8025 ports)
• MariaDB server (running on 3306 port)
• phpMyAdmin console (running on 8000 port)
• Redis server (running on 6379 port)
• MinIO server (running on 9000 and 8900 ports)

How to use?

First make sure you have Docker installed on your workstation. To run the project, just clone or download the repository and run below command in project directory:

docker-compose up -d

If you wish to install new packages or run any command inside the Docker container, run below command:

docker-compose exec app sh

# run a command e.g., test cases
npm test

License

See LICENSE file.