https://github.com/le4ndro/noderestapiex
Sample API using Node, Express, MongoDB and Docker
https://github.com/le4ndro/noderestapiex
docker docker-compose express mongodb nodejs swagger-ui
Last synced: 3 months ago
JSON representation
Sample API using Node, Express, MongoDB and Docker
- Host: GitHub
- URL: https://github.com/le4ndro/noderestapiex
- Owner: le4ndro
- License: mit
- Created: 2015-06-23T18:00:21.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2019-02-20T03:30:45.000Z (over 7 years ago)
- Last Synced: 2025-01-18T06:13:25.269Z (over 1 year ago)
- Topics: docker, docker-compose, express, mongodb, nodejs, swagger-ui
- Language: JavaScript
- Homepage: https://github.com/le4ndro/NodeRestApiEx
- Size: 43.9 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://nodejs.org/en/) - JavaScript runtime
- [Express](http://expressjs.com/en/4x/api.html) - Web framework
- [Docker](https://docs.docker.com/) - Container platform
- [Swagger-ui](https://swagger.io/swagger-ui/) - API documentation and specification
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
## Authors
- **Leandro Souza** - _Initial work_
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
## Acknowledgments
- This project is in development