GoStack12-Desafio-05: A JavaScript repository from Alquipo

Desafio 05: Primeiro projeto Node.js

🚀 Sobre o desafio

Nesse desafio, foi criado uma aplicação para treinar o que aprendi até agora no Node.js junto ao TypeScript, utilizando o conceito de models, repositories e services!

Essa será uma aplicação para armazenar transações financeiras de entrada e saída, que deve permitir o cadastro e a listagem dessas transações.

🔨 Tecnologias:

🚀 Como rodar este projeto

Para clonar e executar este aplicativo, você precisará de Git, NodeJs Instalado em seu computador.

🌀 Clonando o repositório

# Clone este repositório
$ git clone https://github.com/Alquipo/GoStack12-desafio-05

# Acesse a pasta do projeto no terminal/cmd
$ cd GoStack12-desafio-05

🎲 Rodando a API

# Instale as dependências
$ yarn

# Execute a Aplicação
$ yarn dev:server

# Execute o teste da Aplicação
$ yarn test

# O servidor inciará na porta:3333 - acesse http://localhost:3333

🔑 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 saídas (retiradas). Ao cadastrar uma nova transação, ela deve ser armazenada dentro de um objeto com o seguinte formato :

{
  "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:

{
  "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
  }
}

🤔 Como contribuir para o projeto

Faça um fork do projeto;
Crie uma nova branch com as suas alterações: git checkout -b my-feature
Salve as alterações e crie uma mensagem de commit contando o que você fez:git commit -m "feature: My new feature"
Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT. Veja a LICENÇA para saber mais.

Feito com ❤️ por Alquipo Neto 👋🏽 Entre em contato!

Alquipo/GoStack12-Desafio-05