Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/carlos-hfc/api-rest-nodejs

Projeto desenvolvido no módulo sobre API REST da formação de Node.js
https://github.com/carlos-hfc/api-rest-nodejs

fastify knex nodejs rocketseat rocketseat-ignite sqlite typescript vitest zod

Last synced: about 1 month ago
JSON representation

Projeto desenvolvido no módulo sobre API REST da formação de Node.js

Awesome Lists containing this project

README

        






# :bulb: Sobre

Controle de finanças pessoal desenvolvido no módulo sobre API REST da formação de Node.js da Rocketseat.

## :page_with_curl: Pré-requisitos

1. Antes de começar, certifique-se de ter o Node.js instalado em sua máquina.

Node.js

## :gear: Configuração

1. Clone o repositório para sua máquina local:

```bash
git clone https://github.com/carlos-hfc/api-rest-nodejs
```

2. Acesse o diretório do projeto:

```bash
cd api-rest-nodejs
```

3. Instale as dependências:

```bash
npm install
```

4. Crie um arquivo `.env.local` na raiz do projeto e adicione as seguinte chaves:

```env
NODE_ENV=""
DATABASE_URL=""
```

5. Rode a aplicação

```bash
npm run dev
```

## :computer_mouse: Features

### Requisitos funcionais

- :ballot_box_with_check: O usuário pode criar uma nova transação
- :ballot_box_with_check: O usuário pode obter um resumo da sua conta
- :ballot_box_with_check: O usuário pode listar todas as transações que já ocorreram
- :ballot_box_with_check: O usuário pode visualizar uma transação única

### Regras de negócio

- :ballot_box_with_check: A transação pode ser do tipo crédito que somará ao valor total, ou débito, que subtrairá
- :ballot_box_with_check: Deve ser possível identificar o usuário entre as requisições
- :ballot_box_with_check: O usuário só pode visualizar transações criadas por ele

## :computer: Tecnologias utilizadas


Node.js
TypeScript

## :page_facing_up: Licença

Este projeto está licenciado sob a [Licença MIT](LICENSE).