Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avrcoelho/customers-backend-node
https://github.com/avrcoelho/customers-backend-node
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/avrcoelho/customers-backend-node
- Owner: avrcoelho
- Created: 2019-08-29T01:13:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-08-30T23:52:06.000Z (over 5 years ago)
- Last Synced: 2024-11-08T04:40:14.509Z (2 months ago)
- Language: JavaScript
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# API Customers
API desenvolvida em NodeJS e utilizando o bando de dados não relacional MongoDB.
Está API conta com validação de dados e utiliza a dependencia Sentry para poder monitora-la
quando estiver em ambiente de produção.
## Instalar dependencias
```
npm install ou yarn
```
## Configuração do .env
no arquivo .env configure as variaveis do caminho do banco e caso deseja utilizar o sentry, configura o DNS
## Executando (Modo de desenvolvimento)
```
npm run dev ou yarn dev
```
## Executando (Modo de produção)
```
npm run start ou yarn start
```
## Observação
Execute o docker compose para criar a imagem do banco. Caso queira sar ele tambem, execute `docker-compose up`
## Endpoints
```
GET /customers
GET /customers/{id}
DELETE /customers/{id}
PUT /customers/{id}
POST /customers
```
## Dependencias
- [Sentry](https://www.npmjs.com/package/@sentry/node)
- [cors](https://www.npmjs.com/package/cors)
- [dotenv](https://www.npmjs.com/package/dotenv)
- [express](https://www.npmjs.com/package/express)
- [express-async-handler](https://www.npmjs.com/package/express-async-handler)
- [express-validation](https://www.npmjs.com/package/express-validation)
- [joi](https://www.npmjs.com/package/joi)
- [mongoose](https://mongoosejs.com/)
- [mongoose-sequence](https://www.npmjs.com/package/mongoose-sequence)
- [require-dir](https://www.npmjs.com/package/require-dir)
- [youch](https://www.npmjs.com/package/youch)
## Dependencias de desenvolvimento
- [eslint](https://www.npmjs.com/package/eslint)
- [eslint-config-standard](https://www.npmjs.com/package/eslint-config-standard)
- [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)
- [eslint-plugin-node](https://www.npmjs.com/package/eslint-plugin-node)
- [eslint-plugin-promise](https://www.npmjs.com/package/eslint-plugin-promise)
- [eslint-plugin-standard](https://www.npmjs.com/package/eslint-plugin-standard)
- [nodemon](https://github.com/remy/nodemon)