Skip to content

README.md

Latest commit

 

History

History
54 lines (33 loc) · 1.31 KB

README.md

File metadata and controls

54 lines (33 loc) · 1.31 KB

Node-Express-API

This is a template of a NodeJS API using ExpressJS, docker & docker-compose

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.

Prerequesites

What things you need to install the software and how to install them

  1. NodeJS
  2. Docker
  3. Docker-Compose

Installing

  1. Cloning the repo
git clone https://github.com/jbheber/node-express-api.git
  1. Installing dependencies
cd node-express-api
npm i
  1. Starting the api
npm start
// or start the api in a docker container
docker-compose up

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Juan Heber - Initial work - jbheber

License

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