https://github.com/https-eduardo/relt-save-backend
The backend of ReltSave app, built using Typescript, Nest.js and PostgresDB.
https://github.com/https-eduardo/relt-save-backend
Last synced: 9 months ago
JSON representation
The backend of ReltSave app, built using Typescript, Nest.js and PostgresDB.
- Host: GitHub
- URL: https://github.com/https-eduardo/relt-save-backend
- Owner: https-eduardo
- Created: 2023-08-31T14:11:45.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T20:33:10.000Z (about 2 years ago)
- Last Synced: 2024-12-25T15:14:13.318Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 183 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Relt Save Backend
[Relt Save](https://github.com/ReltSave) is an mobile application that manages user's finances, generating reports based on his transactions.
In this repository, you can see the code of the API (backend).
This application was developed as a Final Work as a partial requirement for approval in the course of computer technician at IFPR (Federal Institute of Paraná).
### 👩💻 Technologies used
- Nest.js
- PrismaORM
- PostgresSQL
- Passport (for OAuth 2.0 and JWT authentication)
### ⏳ Future plans
- Add endpoints documentation by using Swagger
- Global code refactor
- Implement rate limiter
- Add unit tests and finish adding E2E tests
### 🚀 How to run
First, ensure your node version is the same as the inside `.nvmrc`. You'll also need to set the enviroment variables at `.env`, following the `.env.example`.
After that, you can install the necessary modules using the command:
```bash
yarn install
```
Now, you can run the app in any mode:
```bash
# development
$ yarn run start
# watch mode
$ yarn run start:dev
# production mode
$ yarn run start:prod
```
You also can run the tests (E2E only, for now):
```bash
# e2e tests
$ yarn run test:e2e
```