Introduction

In-out, an interactive platform for managing personal that offers a variety of advanced features, including an interactive financial dashboard, various types of customizable charts, filters by bank account and date, a detailed table of transactions, a form for adding transactions, customizable selection components, clear distinction between income and expenses, import of transactions via CSV, status management via Tanstack React Query, authentication via Clerk and much more...

Installation

Follow the steps to install and configure the platform.

• Note that you need to have Node +18 installed
• Note that you need all the environment keys filled out

  npm install
  npm run db:generate
  npm run db:migrate
  npm run dev

API documentation

summary

Returns all transactions of the logged-in user

  GET /api/summary

Parameter	Type	Description
from	string	Search start date, format yyyy-MM-dd
to	string	Search end date, format yyyy-MM-dd
accountId	string	The account id to search

accounts

Returns all accounts of the logged-in user

  GET /api/accounts

Returns an specific account of the logged-in user

  GET /api/accounts/:id

Create an account

  POST /api/accounts

Bulk delete accounts

  POST /api/accounts/bulk-delete

Update an account

  PATCH /api/accounts/:id

Parameter	Type	Description
id	string	Required. Account id
name	string	Required. Name of the account
userId	string	Required. User id of the account holder

Delete an account

  DELETE /api/accounts/:id

categories

Returns all categories of the logged-in user

  GET /api/categories

Returns an specific category of the logged-in user

  GET /api/categories/:id

Create an category

  POST /api/categories

Parameter	Type	Description
id	string	Required. Category id
name	string	Required. Name of the category
userId	string	Required. User id of the category holder

Bulk delete categories

  POST /api/categories/bulk-delete

Update an category

  PATCH /api/categories/:id

Parameter	Type	Description
id	string	Required. Category id
name	string	Required. Name of the category
userId	string	Required. User id of the category holder

Delete an category

  DELETE /api/categories/:id

transactions

Returns all transactions of the logged-in user

  GET /api/transactions

Returns an specific transaction of the logged-in user

  GET /api/transactions/:id

Create an transaction

  POST /api/transactions

Parameter	Type	Description
id	string	Required. Transaction id
name	string	Required. Name of the transaction
userId	string	Required. User id of the transaction holder

Bulk delete transactions

  POST /api/transactions/bulk-delete

Update an transaction

  PATCH /api/transactions/:id

Parameter	Type	Description
id	string	Required. Transaction id
name	string	Required. Name of the transaction
userId	string	Required. User id of the transaction holder

Delete an transaction

  DELETE /api/transactions/:id

seed

Seed a test account with random transactions over the last 365 days

  POST /api/seed