NodeRestApiEx

Sample API using Node, Express, MongoDB and Docker

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

What things you need to install the software

• Node.js
• MongoDB
• Docker
• Docker Compose

Installing

1. Clone this repository

$ git clone https://github.com/le4ndro/NodeRestApiEx.git
$ cd NodeRestApiEx

2. Make a local copy of .env.example and edit as needed

$ cp .env.example .env

3. Install dependencies and run the application

$ npm install
$ npm start

4. The API will be served at http://localhost:3001.

Running the Sample With Docker

1. Run the application

$ docker-compose up

2. The API will be served at http://localhost:3001.

Built With

• Node.js - JavaScript runtime
• Express - Web framework
• Docker - Container platform
• Swagger-ui - API documentation and specification

Versioning

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

Authors

• Leandro Souza - Initial work

License

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

Acknowledgments

• This project is in development