Skip to content

lfelipessilva/finad-backend

Repository files navigation

Finad!

Finad is a simple finance administrator app.

📝 Table of Contents

About

This project exists because i wanted to understand better practices to create simple applications.
And also managing your own money suited this case perfectly, it is not too complex, but involves some thinking about the better way to create the architecture.

🏁 Getting Started

Prerequisites

You will need docker and docker-compose (or other database solution), and the NestJS CLI

$ npm i -g @nestjs/cli

Installing

A step by step series of examples that tell you how to get a development env running.

Install NestJS CLI

$ npm i -g @nestjs/cli

Install dependencies

$ yarn

or

$ npm

Run docker

$ docker-compose up -d

Run application

$ yarn start:dev

End with an example of getting some data out of the system or using it for a little demo.

🔧 Running the tests

For testing all you need to do is run the test command

$ yarn test

🎈 Usage

For using, you will need to create and user first, then authenticating it. after that you can create accounts, expenses and incomes and fetch them with filters.

All API docs can be found in the localhost:3000/docs route.

⛏️ Built Using

✍️ Authors

About

Nestjs powered API used to manage Finad!, a finance administrator

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published