Tomas - Purrfect Budgets

Personal and Home finance projection and expense tracking application.

Features

• 📅 Calendar view for transaction planning
• 📊 Monthly reports and summaries
• 💰 Multiple account management
• 🏷️ Category organization
• 📱 Card-based transaction feed view

Documentation

Feature Documentation

• Transaction Feed View - Card-based transaction browsing interface
• Transaction Visual Language - UI/UX guidelines for transaction interfaces
• Implementation Guide - Developer implementation details

Tech Stack

• Frontend:
  • Vue 3 (Composition API)
  • Pinia for state management
  • Bootstrap 5 for UI
  • FullCalendar for calendar view
• Backend:
  • Express.js
  • MySQL database
  • JWT for authentication

Testing

We use automated testing to ensure code quality. See TESTING.md for details on running tests and our CI/CD pipeline.

API Documentation

You can view the interactive Swagger UI documentation by:

1. Installing dependencies: cd api && npm install
2. Running: npm run docs
3. Opening http://localhost:3000/api-docs in your browser

Installation

1.- Clone the repository:

git clone https://github.com/yourusername/tomas.git
cd yamo

2.- Install Dependencies

Install frontend dependencies

cd frontend
npm install

Install backend dependencies

cd ../api
npm install

3.- Configure Environment

Copy example env file

cp .env.example .env

Edit with your database credentials

nano .env

4.- Initialize Database

mysql -u root -p < schema.sql

Development

We try to abide to GitFlow

The development branch is develop, all PRs must point there. main is used for production releases and hotfixes.

Start Backend server

cd api
npm run dev

Start frontend development server

cd frontend
npm run dev

Visit http://localhost:5173 in your browser

Production

Build frontend:

cd frontend
npm run build

Start production server:

cd api
npm start

Deploy to DigitalOcean

This will deploy:

• A single App Platform instance running both frontend and backend
• Requires external MySQL database credentials (not included)
• Automatically deploys from the develop branch

Environment Variables Required

• YAMO_MYSQL_HOST: MySQL server hostname
• YAMO_MYSQL_USER: Database username
• YAMO_MYSQL_PASSWORD: Database password
• YAMO_MYSQL_DATABASE: Database name
• YAMO_MYSQL_PORT: Database port (default: 3306)

License

General Public License v3, check LICENSE.md for details