Flowinance

A financial management app that uses AI for transaction categorization, helping users easily control and visualize their expenses, income, savings, and investments.

Getting Started

Flowinance runs its database on Supabase. Supabase allows you to run a local instance, so you don’t have to worry about breaking the production database. First, we are going to configure Supabase locally, following the documentation that Supabase provides. In this example, we will do it using a Mac, but check their documentation for adapting it to your operating system.

Install the Supabase CLI:
```
brew install supabase/tap/supabase
```
The Supabase CLI uses Docker containers to manage the local development stack. Install Docker.
Run Docker.
Run Supabase locally:
```
supabase start
```

Once all of the Supabase services are running, you'll see output containing your local Supabase credentials. Copy them into your .env.local file:

Started supabase local development setup.

       API URL: http://localhost:54321
       DB URL: postgresql://postgres:postgres@localhost:54322/postgres
   Studio URL: http://localhost:54323
   Inbucket URL: http://localhost:54324
       anon key: eyJh......
service_role key: eyJh......

You can check Supabase studio at http://localhost:54323

When you are finished working on your Supabase project, you can stop the stack:
```
supabase stop
```
Install dependencies:
```
npm i
```
Flowinance uses Prisma for handling the types and migrations of the database. If this is the first time you are setting up the project, generate the tables for your Supabase local instance:
```
npx prisma migrate dev --name init
```
You may get an error Environment variable not found: DATABASE_URL. To fix it, run:
```
export DATABASE_URL="postgresql://postgres:postgres@localhost:54322/postgres"
```
That's it! 🎉 Run Flowinance's development server and open http://localhost:3000:
```
npm run dev
```

Features

✅ Display an overview of finances through a Dashboard
✅ Artificial intelligence transaction categorization
✅ Organized display of all transactions
✅ End-to-end encryption
✅ Multi-currency
✅ Export all categorized transactions
Import all categorized transactions

Contributing

We would be really happy if you decide to contribute. Please read our CONTRIBUTING.md guide before 😊

Join our community

Feel free to join us: Flowinance Discussions for general questions, feature suggestions, or to engage with our community.

Ask me

You can always contact me via Telegram if you want to talk more about the project 😊

License

GNU General Public License v3.0

manuelalferez / flowinance

readme