Skip to content

Latest commit

 

History

History
84 lines (56 loc) · 2.39 KB

README.md

File metadata and controls

84 lines (56 loc) · 2.39 KB

Finflow

Finflow Placeholder Image

Finflow is a powerful expense tracker that helps you monitor your expenses and manage your income effectively. Choose between default categories or create your own for a personalized experience.

Features

  • Expense/Income Addition: Easily add and categorize your expenses and income.
  • Customized Reports: Generate detailed reports for your transactions.
  • Graphs and Charts: Visualize your spending with graph comparisons and pie charts.
  • Data Export: Export your transaction data for external use.

Upcoming Features

  • Recurring Transactions: Automate frequent expenses or income.
  • Budget Management: Set and track spending limits for specific categories.
  • Multi-Currency Support: Handle expenses and income in different currencies.
  • Mobile App Integration: Access Finflow on the go with a companion mobile app.

Tech Stack

Next.js TypeScript PostgREST Prisma

Local Setup

Prerequisites

Ensure you have the following installed:

  • Node.js (v16 or later)
  • npm or yarn
  • PostgreSQL database

Steps to Setup

  1. Clone the repository:

    git clone https://github.com/your-username/finflow.git
cd finflow

  2. Install dependencies:

    npm install

  3. Set up the database using Prisma:

    npx prisma migrate dev

  4. Copy the environment file and configure:

    cp .env.example .env

    Fill in the necessary details in the .env file, such as your database connection string and other configurations.

  5. Start the development server:

    npm run dev

  6. Open the app in your browser at http://localhost:3000.

Contributing

We welcome contributions! Please open an issue or submit a pull request to suggest features or fixes.

License

This project is licensed under the MIT License. See the LICENSE file for details.