⚙️ Start   |    ℹ️ Content   |    🚀 Technologies   |    💻 Author   |    📝 License

GoFinances is a simple financial control project developed during Rocketseat's GoStack 11. Its API is built using TypeORM and TypeScript.

---

⚙️ Start

# Clone o Repositório
git@github.com:tavareshenrique/go-finances-api.git

## Baixe as dependencias
yarn

# Inicie o Projeto
yarn dev:server

---

ℹ️ Content

• Transactions
  • List All
  • Create
  • Create/Import

---

Transactions

List All Transactions

List All Transactions.

• URL

  /transactions

• Method:

  GET

• URL Params

  Required:

  None

  Optional:

• Data Params

  None

• Success Response:

  • Code: 200
    Content:

    {
      "transactions": [
        {
          "id": "418c5946-db65-422d-8d81-8302e77a8a81",
          "title": "Salary",
          "type": "income",
          "value": 3000,
          "category_id": "551915bf-4f34-4791-8a2d-90a962125bc1",
          "created_at": "2020-04-22T05:51:18.258Z",
          "updated_at": "2020-04-22T05:51:18.258Z",
          "category": {
            "id": "551915bf-4f34-4791-8a2d-90a962125bc1",
            "title": "Payment",
            "created_at": "2020-04-22T05:51:18.242Z",
            "updated_at": "2020-04-22T05:51:18.242Z"
          }
        },
      ]
    }

---

Create Transaction

Create a single Transaction.

• URL

  /transactions

• Method:

  POST

• URL Params

  Required:

  None

• Data Params

  {
   "title": "Electricity bill",
   "value": 400,
   "type": "outcome",
   "category": "Home"
  }

• Success Response:

  • Code: 200
    Content:

    {
      "title": "Electricity bill",
      "type": "outcome",
      "value": 400,
      "id": "8587c56f-f5ba-4d8d-94b0-409a8d249d8c",
      "category": "Home"
    }

---

Create/Import Transaction

Import transaction from CSV file.

• URL

  /transactions

• Method:

  POST

• URL Params

  Required:

  file - Multipart Form

• Data Params

• Success Response:

  • Code: 200
    Content:

    {
      "title": "Electricity bill",
      "type": "outcome",
      "value": 400,
      "id": "8587c56f-f5ba-4d8d-94b0-409a8d249d8c",
      "category": "Home"
    }

---

🚀 Technologies

• Express
• TypeScript
• cors
• node-csv-parse
• csvtojson
• express-async-errors
• multer
• pg
• eslint
• prettier

---

💻 Author

Henrique Tavares @tavareshenrique 💻

Rocketseat @Rocketseat 💻

---

📝 License

This project is licensed under the MIT license - see the archive LICENSE.md for details.