README.md

Financial

This application was developed for a college project. The project consists of an API for registering account types and bills with a three-level permission system: Admin, Finance, Manager.

Environment Variables

To run this project, you need to copy the ​​environment variables from the .env.example file and populate it. The files you need to fill in are: .env, .env.dev, .env.test

Run Locally

Clone the project

  git clone https://github.com/gleysonabreu/financial.git

Go to the project directory

  cd financial

Install dependencies

  npm install
  or
  yarn install

Install migrations

npm run typeorm migration:run
or
yarn typeorm migration:run

Start the server

  npm run dev
  or
  yarn dev

DOCS

After you start the server you can access the documentation at the following link:

• http://localhost:3333/api-docs

Running Tests

To run tests, run the following command

  npm run test
  or
  yarn test

Demo

• DOCS
• API

Tech

• Node
• Express
• Typescript
• TypeORM
• Swagger

Authors

• @gleysonabreu