Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/diegovictor/gofinances-api
Project built during the Rocketseat Bootcamp #11
https://github.com/diegovictor/gofinances-api
api coverage-report database editorconfig eslint gofinances gostack node nodejs postgres prettier rocketseat ts typescript
Last synced: 16 days ago
JSON representation
Project built during the Rocketseat Bootcamp #11
- Host: GitHub
- URL: https://github.com/diegovictor/gofinances-api
- Owner: DiegoVictor
- License: mit
- Created: 2020-06-11T18:08:08.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-02-15T12:04:54.000Z (9 months ago)
- Last Synced: 2024-02-15T13:27:10.635Z (9 months ago)
- Topics: api, coverage-report, database, editorconfig, eslint, gofinances, gostack, node, nodejs, postgres, prettier, rocketseat, ts, typescript
- Language: TypeScript
- Homepage:
- Size: 2.25 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [API] GoFinances
[](https://ci.appveyor.com/project/DiegoVictor/gofinances-api)
[](https://www.typescriptlang.org/)
[](https://eslint.org/)
[](https://github.com/airbnb/javascript)
[](https://jestjs.io/)
[](https://codecov.io/gh/DiegoVictor/gofinances-api)
[](https://raw.githubusercontent.com/DiegoVictor/gofinances-api/main/LICENSE)
[](http://makeapullrequest.com)
[](https://insomnia.rest/run/?uri=https%3A%2F%2Fraw.githubusercontent.com%2FDiegoVictor%2Fgofinances-api%2Fmain%2FInsomnia_2020-09-06.json&label=GoFinances)
Responsible for provide data to the [`web`](https://github.com/DiegoVictor/gofinances-web) front-end. Allow users to register income and outcome transactions.
## Table of Contents
* [Installing](#installing)
* [Configuring](#configuring)
* [Postgres](#postgres)
* [Migrations](#migrations)
* [.env](#env)
* [Usage](#usage)
* [Error Handling](#error-handling)
* [Errors Reference](#errors-reference)
* [X-Total-Count](#x-total-count)
* [Versioning](#versioning)
* [Routes](#routes)
* [Requests](#requests)
* [Running the tests](#running-the-tests)
* [Coverage report](#coverage-report)
# Installing
Easy peasy lemon squeezy:
```
$ yarn
```
Or:
```
$ npm install
```
> Was installed and configured the [`eslint`](https://eslint.org/) and [`prettier`](https://prettier.io/) to keep the code clean and patterned.
## Configuring
The application use just one database: [Postgres](https://www.postgresql.org/). For the fastest setup is recommended to use [docker-compose](https://docs.docker.com/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](https://typeorm.io/#/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](#error-handling)). 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`
# 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:
```json
{
"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](#errors-reference)) you can see the errors `code` description.
### Errors Reference
|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.
## 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
|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.
### Requests
* `POST /transactions`
Request body:
```json
{
"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](https://jestjs.io/) 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.