Skip to content

Latest commit

 

History

History
71 lines (47 loc) · 1.82 KB

README.md

File metadata and controls

71 lines (47 loc) · 1.82 KB
Raw

Budget Plan

An application that will help you plan your budget. With this app, you can:

  • create budgets with an estimated maximum value for both categories of finances - expenses and profits; you can also edit them after creating them,
  • note expenses and incomes with an assigned budget and optional description, with the ability to edit all data in the future,
  • monitor the realization of all your budgets in a simple summary,
  • download a CSV file with all your information about added expenses and incomes using the app.

Used technologies 🛠️:

  1. React.js
  2. Next.js (v13 with appDir)
  3. Typescript
  4. Tailwind CSS
  5. Prisma
  6. Postgresql (Supabase)
  7. next-auth
  8. TanStack Query
  9. mailjet as a SMTP provider
  10. react-hook-form for handling forms
  11. zod for data validation

Installation 👷

Required: node.js v18 and docker with docker compose command.

  1. Clone this repository:
git clone https://github.com/grzegorzpokorski/budget-plan.git
  1. Install dependencies:
pnpm install
  1. Setup environment variables:

To run it in local environment firstly you should prepare .env file with required enviroment variables - example file is in the project (.env-example).

  1. Run project:
docker compose up
pnpm dlx prisma migrate dev
pnpm dlx prisma generate
pnpm dev

Live 🌐

https://budget-plan-ashy.vercel.app/

Some screenshots:

Contributing

If you find any bug, have suggestion how to improve this project feel free to tell about it in issues tab. Pull requests also are welcoming.