Project built during the Rocketseat Bootcamp #11
MIT License
Responsible for provide data to the web
front-end. Allow users to register income and outcome transactions.
Easy peasy lemon squeezy:
$ yarn
Or:
$ npm install
Was installed and configured the
eslint
andprettier
to keep the code clean and patterned.
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
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
andtests
(in case you would like to run the tests).
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.
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.
key | description | default |
---|---|---|
APP_PORT | Port number where the app will run. | 3333 |
NODE_ENV | App environment. The typeORM's database choice rely on this key value, so if the environment is test the database used will be tests otherwise the POSTGRES_DATABASE will set the database name. |
development |
POSTGRES_HOST | Postgres host. | pg |
POSTGRES_PORT | Postgres port. | 5432 |
POSTGRES_USER | Postgres user. | postgres |
POSTGRES_PASSWORD | Postgres password. | - |
POSTGRES_DATABASE | Application's database name. | gofinances |
DOCS_URL | An url to docs where users can find more information about the app's internal code errors. | https://github.com/DiegoVictor/gofinances-api#errors-reference |
To start up the app run:
$ yarn dev:server
Or:
npm run dev:server
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 errorscode
description.
code | message | description |
---|---|---|
140 | Missing file | Was not provided a file to import transactions. |
141 | You don't have enough money to this transaction! | The said amount is greater than the available. |
144 | Transaction not found | The id sent not references an existing transaction in the database. |
Another header returned in routes with pagination, this bring the total records amount.
A simple versioning was made. Just remember to set after the host
the /v1/
string to your requests.
GET http://localhost:3333/v1/transactions
route | HTTP Method | params | description |
---|---|---|---|
/transactions |
GET | - | Return transactions and balance. |
/transactions |
POST | Body with transaction title , value , type and category . |
Create a new transaction. |
/transactions/:id |
DELETE |
:id of the transaction. |
Remove a transaction. |
/transactions/import |
POST | Multipart payload with a file field with a csv file. |
Import transactions from file. |
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
Jest was the choice to test the app, to run:
$ yarn test
Or:
$ npm run test
For tests run create a database called
tests
.
You can see the coverage report inside tests/coverage
. They are automatically created after the tests run.