https://github.com/nathaliacosim/elenco-back
https://github.com/nathaliacosim/elenco-back
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nathaliacosim/elenco-back
- Owner: nathaliacosim
- Created: 2023-12-11T19:24:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-11T19:43:58.000Z (over 1 year ago)
- Last Synced: 2023-12-11T20:32:22.577Z (over 1 year ago)
- Language: TypeScript
- Size: 89.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Plano de Contas Contábeis
Este é um projeto para gerenciar um Plano de Contas Contábeis utilizando NestJS e MongoDB.
## Pré-requisitos
Antes de começar, certifique-se de ter as seguintes ferramentas instaladas no seu sistema:
- [Node.js](https://nodejs.org/)
- [npm](https://www.npmjs.com/) ou [Yarn](https://yarnpkg.com/)
- MongoDB
### Instalação
1. Clone o repositório: `git clone https://github.com/nathaliacosim/elenco-back`
2. Acesse o diretório do projeto: `cd elenco-back`
3. Instale as dependências: `npm install` ou `yarn install`
1. Crie um arquivo `.env` na raiz do projeto e configure as variáveis de ambiente necessárias:
```env
DB_USER=seu_usuario
DB_PASSWORD=sua_senha
```
### Uso
1. Inicie o servidor:
```npm run start ou yarn start```
2. O servidor estará disponível em por padrão.
### Endpoints da API
- POST /contas
```Cria uma nova conta contábil.```
- GET /contas
```Obtém todas as contas contábeis.```
- GET /contas/:id
```Obtém uma conta contábil por ID.```
- PUT /contas/:id
```Atualiza uma conta contábil - existente.```
- DELETE /contas/:id
```Remove uma conta contábil por ID.```
- DELETE /contas
```Remove todas as contas contábeis.```
---
Desenvolvido com amor. ❤️