About | Features | Technologies | Requirements | Starting | API Docs | Environment File
A NodeJS API to register Cash Flow built with TypeScript and SOLID pattern
✔️ Register Cash Flow (Income/Outcome);
✔️ Register User;
✔️ Financial Summary.
This project uses:
Before you start the project you will need Docker installed in your machine.
# Install dependencies
$ yarn install
# Build application
$ yarn build
# Test application
$ yarn test
To check the API documentaton and endpoints, see Documentation
Before you create the Microservice, you need to configure you .env.example file and change to .env. DB_HOST must be set to the same name as the Database Docker service. i.e. db
After you configure the .env and build you API, you can run docker-compose up -d --no-recreate command.
This will create two docker instances, one for the NodeJS API and the other for the PostgreSQL database and run the TypeORM Migrations.