Skip to content

HugoRamonPereira/Fincheck

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 

Repository files navigation

FINCHECK - App to manage your finances and budget

FINCHECK BACKEND - API

STACK USED TO BUILD THE PROJECT

Out backend is built using Node.js with Nest.

The Database we chose to implement in the Fincheck was Postgres with Prisma as our ODM (Object Data Modelling).

The port we are using for the Database to be running is 5432 and we are using Docker to run it.

We organized the application in modules, each module folder contains its respectives dtos, entities and services, not all have the same sequence of folders due to specific cases of each.

TO RUN THE PROJECT

Since we are using Yarn as our Package Manager we will run the commands using yarn.

  • To run in Development mode we use the command:
yarn start:dev
  • To run our backend in Production Mode we will use the command:
yarn build

This command will execute node and the folder dist which contains the code of our backend/server turned into Javascript

FINCHECK FRONTEND - WEB APPLICATION

The project was built using React.js and Vite with Yarn as out package manager.

As for the UI, we've used TailwindCSS, Clsx to style it with the help of Headless UI to get the animations and also Radix to style our modals, dropdowns, select, dialogs and other components. Also, we've used Swiper for the account cards, transaction months we have in our application. To display toast notifications we used React-Hot-Toast. A calendar was implemented and for that we used a library called React Day Picker. To handle the values of balance, transactions we used a number library called React-Number-Format.

To handle the forms across our applications we've used React-Hook-Form in combination with Zod

These are the steps to execute our project:

  • To run in Development mode we use the command:
yarn dev

The command yarn dev will execute vite.

  • To run the command to build the project we use:
yarn build

The command yarn build will execute tsc which means Typescript Compiler that will turn the Typescript code into Javascript to be understood by the browsers.

API COMSUME USING AXIOS & REACT QUERY

To handle our requests to the backend we are using Axios and also React Query.

License

© Done with a lot of ❤ by Hugo Ramon Pereira -> Portfolio -> LinkedIn 🇧🇷

About

Software for managing your personal budget and finances.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published