[API] GoFinances

Responsible for provide data to the web front-end. Allow users to register income and outcome transactions.

Table of Contents

• Installing
  • Configuring
    • Postgres
      • Migrations
    • .env
• Usage
  • Error Handling
    • Errors Reference
  • X-Total-Count
  • Versioning
  • Routes
    • Requests
• Running the tests
  • Coverage report

Installing

Easy peasy lemon squeezy:

$ yarn

Or:

$ npm install

Was installed and configured the eslint and prettier to keep the code clean and patterned.

Configuring

The application use just one database: Postgres. For the fastest setup is recommended to use docker-compose, you just need to up all services:

$ docker-compose up -d

Postgres

Responsible to store all application data. If for any reason you would like to create a Postgres container instead of use docker-compose, you can do it by running the following command:

$ docker run --name gofinances-postgres -e POSTGRES_PASSWORD=docker -p 5432:5432 -d postgres

Then create two databases: gofinances and tests (in case you would like to run the tests).

Migrations

Remember to run the database migrations:

$ yarn ts-node-dev ./node_modules/typeorm/cli.js migration:run

Or:

$ yarn typeorm migration:run

See more information on TypeORM Migrations.

.env

In this file you may configure your Postgres database connection, the environment, app's port and a url to documentation (this will be returned with error responses, see error section). Rename the .env.example in the root directory to .env then just update with your settings.

Usage

To start up the app run:

$ yarn dev:server

Or:

npm run dev:server

Error Handling

Instead of only throw a simple message and HTTP Status Code this API return friendly errors:

{
  "status": "error",
  "message": "Transaction not found",
  "code": 144,
  "docs": "https://github.com/DiegoVictor/gofinances-api#errors-reference"
}

As you can see a url to error docs are returned too. To configure this url update the DOCS_URL key from .env file. In the next sub section (Errors Reference) you can see the errors code description.

Errors Reference

X-Total-Count

Another header returned in routes with pagination, this bring the total records amount.

Versioning

A simple versioning was made. Just remember to set after the host the /v1/ string to your requests.

GET http://localhost:3333/v1/transactions

Routes

Requests

• POST /transactions

Request body:

{
  "title": "Internet",
  "value": 120,
  "type": "outcome",
  "category": "Others"
}

• POST /transactions/import

CSV file, example:

title, type, value, category
Loan, income, 1500, Others
Website Hosting, outcome, 50, Others
Ice cream, outcome, 3, Food

Running the tests

Jest was the choice to test the app, to run:

$ yarn test

Or:

$ npm run test

For tests run create a database called tests.

Coverage report

You can see the coverage report inside tests/coverage. They are automatically created after the tests run.