https://github.com/cristobalgvera/fintual-tracker
Application to track personal profit and losses when using Fintual app
https://github.com/cristobalgvera/fintual-tracker
backend devcontainer docker docker-compose gh-workflow javascript nest nestjs nodejs postgresql typeorm typescript workflow
Last synced: 2 months ago
JSON representation
Application to track personal profit and losses when using Fintual app
- Host: GitHub
- URL: https://github.com/cristobalgvera/fintual-tracker
- Owner: cristobalgvera
- License: mit
- Created: 2023-02-25T01:51:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-07T22:50:58.000Z (about 3 years ago)
- Last Synced: 2025-12-12T20:54:41.639Z (6 months ago)
- Topics: backend, devcontainer, docker, docker-compose, gh-workflow, javascript, nest, nestjs, nodejs, postgresql, typeorm, typescript, workflow
- Language: TypeScript
- Homepage:
- Size: 211 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Installation
```bash
$ yarn install
```
## :exclamation: Database
The project persist data using TypeORM. To accomplish this, it uses migrations
as a database versioning system. It's important to follow the convention in order
to encourage the maintainability of the project.
Every migration generated or created is located in the [migrations folder](./src/core/database/migrations/).
The easiest way to make use of this migrations system is to follow the [workflow](#workflow)
proposed below. It make extensive use of the custom scripts located in the
[package.json](./package.json) file
### Workflow
The workflow to proper modify the database schema is the following:
1. Make changes to your entities.
1. Run `npm run migration:generate --name=YourMigrationName -- --dr` and
watch the generated output. If it is correct, proceed to the next step, else
go back and make changes to your entities again.
1. Run `npm run migration:generate --name=YourMigrationName`.
1. Do one of these:
- Launch the app building it before (`npm run build` and then `npm run start:dev`).
- Run the migration manually using `npm run migration:run`
1. Check your changes in the database. If there are unwanted changes, run
`npm run migration:revert`, remove the previously generated file, and start
again.
1. Commit your changes.
### Migration related scripts
```bash
# generate migration based on your changes
$ npm run migration:generate --name=YourMigrationName
# generate migration in dry run (don't write anything)
$ npm run migration:generate --name=YourMigrationName -- --dr
# create an empty migration file
$ npm run migration:create --name=YourMigrationName
# run migrations manually
$ npm run migration:run
# revert last migration
$ npm run migration:revert
```
## Running the app
```bash
# development
$ yarn run start
# watch mode
$ yarn run start:dev
# production mode
$ yarn run start:prod
```
## Test
```bash
# unit tests
$ yarn run test
# e2e tests
$ yarn run test:e2e
# test coverage
$ yarn run test:cov
```
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## Stay in touch
- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)
## License
Nest is [MIT licensed](LICENSE).