Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rimiti/mongo-rest-api
Dockerized REST API example which uses Mongo, Aclify, Express, Pagination, JWT, Celebrate...
https://github.com/rimiti/mongo-rest-api
acl docker docker-compose express jest jwt mongodb mongoose supertest tests
Last synced: 24 days ago
JSON representation
Dockerized REST API example which uses Mongo, Aclify, Express, Pagination, JWT, Celebrate...
- Host: GitHub
- URL: https://github.com/rimiti/mongo-rest-api
- Owner: rimiti
- Created: 2019-02-20T12:42:26.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2019-03-13T11:11:58.000Z (almost 6 years ago)
- Last Synced: 2024-11-07T16:12:12.876Z (2 months ago)
- Topics: acl, docker, docker-compose, express, jest, jwt, mongodb, mongoose, supertest, tests
- Language: JavaScript
- Homepage: https://dimsolution.com
- Size: 176 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mongo-rest-api
[](https://travis-ci.org/rimiti/mongo-rest-api) [](https://codecov.io/gh/rimiti/mongo-rest-api)
## Description
Simple Dockerized API which uses Mongo, Aclify, Express, Pagination, JWT, Celebrate...
## Pre-requirements
- Docker
- Docker Compose
## How to use it?
### Tests
All tests are dockerized.
```sh
$ yarn docker:run:test
```
### Development environment
Development environment is dockerized too.
```sh
$ yarn docker:run:development
```
### Accessing
```sh
http://127.0.0.1:3000
```
## Scripts
Run using yarn `` command.
lint - Eslint + prettier check.
lint:fix - Eslint + prettier auto fixing.
test - Run tests with coverage.
build - Compile source files.
build:watch - Interactive watch mode, compile sources on change.
docker:wait - Wait until stack will be ready.
docker:run:development - Runs development environment.
docker:run:test - Runs tests.
docker:init:development - Initialize development environment.
docker:init:test - Initialize test environment.