Sample API using Node, Express, MongoDB and Docker
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.
What things you need to install the software
- Node.js
- MongoDB
- Docker
- Docker Compose
- Clone this repository
$ git clone https://github.com/le4ndro/NodeRestApiEx.git
$ cd NodeRestApiEx
- Make a local copy of .env.example and edit as needed
$ cp .env.example .env
- Install dependencies and run the application
$ npm install
$ npm start
- The API will be served at http://localhost:3001.
- Run the application
$ docker-compose up
- The API will be served at http://localhost:3001.
- Node.js - JavaScript runtime
- Express - Web framework
- Docker - Container platform
- Swagger-ui - API documentation and specification
We use SemVer for versioning. For the versions available, see the tags on this repository.
- Leandro Souza - Initial work
This project is licensed under the MIT License - see the LICENSE file for details
- This project is in development