Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anddersonrds/v2-typescript-concepts
Project study of typescript concepts to solve the challenge proposed by Rocketseat
https://github.com/anddersonrds/v2-typescript-concepts
Last synced: about 2 months ago
JSON representation
Project study of typescript concepts to solve the challenge proposed by Rocketseat
- Host: GitHub
- URL: https://github.com/anddersonrds/v2-typescript-concepts
- Owner: anddersonrds
- Created: 2020-05-18T01:38:47.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T02:35:51.000Z (almost 2 years ago)
- Last Synced: 2023-03-07T06:42:46.339Z (almost 2 years ago)
- Language: JavaScript
- Size: 1.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Sobre o desafio
Deve criar uma aplicação com Node.js junto ao TypeScript, utilizando o conceito de models, repositories e services!
Essa será uma aplicação para que deve armazenar transações financeiras de entrada e saída, que deve permitir o cadastro e a listagem dessas transações.
### Como rodar o projeto
Ao fazer o gitclone execute o seguintes comandos dentro da pasta do projeto:
```yarn``` para baixar todas as dependências ultilzadas.
```yarn dev:server``` para rodar a aplicação.
``yarn test`` para rodar os testes.
Na raiz do projeto está o arquivo **insomnia.json** para importar no Insomnia para utilizar a rotas já configuradas.
### Rotas da aplicação
- **`POST /transactions`**: A rota deve receber `title`, `value` e `type` dentro do corpo da requisição, sendo `type` o tipo da transação, que deve ser `income` para entradas (depósitos) e `outcome` para saidas (retiradas). Ao cadastrar uma nova transação, ela deve ser armazenada dentro de um objeto com o formato como o seguinte:
```json
{
"id": "uuid",
"title": "Salário",
"value": 3000,
"type": "income"
}
```
- **`GET /transactions`**: Essa rota deve retornar uma listagem com todas as transações que você cadastrou até agora, junto com o valor de soma de entradas, retiradas e total de crédito. Essa rota deve retornar um objeto com o formato a seguir:
```json
{
"transactions": [
{
"id": "uuid",
"title": "Salário",
"value": 4000,
"type": "income"
},
{
"id": "uuid",
"title": "Freela",
"value": 2000,
"type": "income"
},
{
"id": "uuid",
"title": "Pagamento da fatura",
"value": 4000,
"type": "outcome"
},
{
"id": "uuid",
"title": "Cadeira Gamer",
"value": 1200,
"type": "outcome"
}
],
"balance": {
"income": 6000,
"outcome": 5200,
"total": 800
}
}
```
**Dica**: Dentro de balance, o income é a soma de todos os valores das transações com `type` income. O outcome é a soma de todos os valores das transações com `type` outcome, e o total é o valor de `income - outcome`.
**Dica 2**: Para fazer a soma dos valores, você pode usar a função [reduce](https://developer.mozilla.org/pt-BR/docs/Web/JavaScript/Reference/Global_Objects/Array/reduce) para agrupar as transações pela propriedade `type`, assim você irá conseguir somar todos os valores com facilidade e obter o retorno do `balance`.
### Específicação dos testes
Em cada teste, tem uma breve descrição no que sua aplicação deve cumprir para que o teste passe.
Para esse desafio temos os seguintes testes:
- **`should be able to create a new transaction`**: Para que esse teste passe, sua aplicação deve permitir que uma transação seja criada, e retorne um json com a transação criado.
- **`should be able to list the transactions`**: Para que esse teste passe, sua aplicação deve permitir que seja retornado um objeto contendo todas as transações junto ao balanço de income, outcome e total das transações que foram criadas até o momento.
- **`should not be able to create outcome transaction without a valid balance`**: Para que esse teste passe, sua aplicação não deve permitir que uma transação do tipo `outcome` extrapole o valor total que o usuário tem em caixa, retornando uma resposta com código HTTP 400 e uma mensagem de erro no seguinte formato: `{ error: string }`
## :memo: Licença
Esse projeto está sob a licença MIT. Veja o arquivo [LICENSE](LICENSE) para mais detalhes.
---
Feito com 💜 by Anderson Rodrigues