FinB

A simple expense organizer app built with Ruby on Rails and SQLite. This app is designed for personal use, allowing users to track and manage their monthly expenses.

Features

• Expense Tracking: Log your daily expenses and categorize them for better organization.
• Monthly Overview: Get a summary of your monthly spending with a clear breakdown of categories.
• Flexible Deployment: Run the app locally or deploy it on your favorite cloud platform.

Setup

Prerequisites

• For Local Development:
  • Ruby 3.3+
  • SQLite 3
  • Bundler gem
• For Docker Deployment:
  • Docker

Local Development Setup

1. Clone the repository:

git clone https://github.com/mtayllan/finb.git
cd finb

2. Install dependencies:

bundle install

3. Setup the database:

bin/rails db:setup

4. (Optional) Configure Groq API for PDF import:

cp .env.example .env
# Edit .env and add your Groq API key:
# GROQ_API_KEY=your_api_key_here

Get your free API key at console.groq.com

5. Start the development server:

bin/dev

6. Access the application at http://localhost:3000

Docker Deployment

1. Clone the repository:

git clone https://github.com/mtayllan/finb.git
cd finb

2. Build the Docker image:

docker build -t finb .

3. Run the container:

docker run \
  -d -p 9090:3000 \
  --name finb \
  -v finb-storage:/rails/storage \
  --env SECRET_KEY_BASE=$YOUR_SECRET_KEY_BASE \
  --env USE_SSL=false \
  --env GROQ_API_KEY=$YOUR_GROQ_API_KEY \
  finb

Notes:

• Generate a random secret key base with openssl rand -hex 64 and replace $YOUR_SECRET_KEY_BASE with the generated value.
• (Optional) Add your Groq API key to enable PDF import feature. Get a free key at console.groq.com and replace $YOUR_GROQ_API_KEY with your key. If you don't need PDF import, you can omit the --env GROQ_API_KEY line.

4. Access the application at http://localhost:9090

Updating Docker Deployment

1. Pull the latest changes:

git pull origin main

2. Rebuild the Docker image:

docker build -t finb .

3. Stop and remove the old container:

docker stop finb
docker rm finb

4. Start the new container using the same docker run command from step 3 above.

License

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

Feedback

If you have any feedback, feel free to open a new Issue and we can discuss!