node-babel-boilerplate

Minimal boilercode to kickstart your Node.js project using Babel and ES6.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Before running the project on your system, make sure you have the following software installed.

• yarn - fast and reliable dependency management from Facebook
• Docker - OS level virtualization to deliver packages called containers (optional)

Installing

Before running the program make sure you have the .env file in the root directory of the project.

PORT="<CHANGEME>"

The program can be run in "development" mode for testing and development purposes using the following command:

yarn start:dev

Deployment

The code is written to run in the local and as well as in containerized environment.

Build the project using the following command:

yarn build

The project can be run in production environment using:

yarn start:prod

Or build the Docker image using the following command:

docker build -t node-babel-boilerplate .

And run the container using the following command:

docker run node-babel-boilerplate

Technologies

• Babel - Compile JavaScript to a primitive version
• Docker - OS level virtualization
• Koa - Next generation web framework for Node.js

Authors

• Wahaj Aayani - Initial work - aayani

License

This project is licensed under the MIT License - see the LICENSE file for details