💰 Gig Money Tracker

A desktop application built with Electron and SQLite to help gigging musicians to track their income (eg. when is the gig and whether the payment has been received or not) and better organise their finance.

Features

• Gig Management: Add, edit, and delete gigs
• Income Tracking: Track earnings with status updates (pending, completed, cancelled)
• Financial Analytics: View total earnings and income tracking
• Modern UI: Clean, responsive interface with real-time updates
• Local Storage: Data stored locally using SQLite database (no need to connect to the internet)

Tech Stack

• Frontend: HTML5, CSS3, JavaScript (ES6+), React
• Backend: Node.js with better-sqlite3
• Desktop Framework: Electron
• Database: SQLite

Installation

First Method:

Install from the file Gig Money Tracker Setup 1.0.0.exe.

Second Method:

(Ensured that Node.js is installed)

1. Clone the repository:

git clone https://github.com/alexgoexercise/gig-money-tracker.git
cd gig-money-tracker

2. Install dependencies:

npm install

3. Start the application:

npm start

Development

For development with DevTools enabled:

npm run dev

Note: Downloading Electron can take a WHILE.

Database Schema

Gigs Table

• id - Primary key
• title - Gig title/name
• description - Optional description
• amount - Payment amount
• date - Gig date
• status - Status (pending, completed, cancelled)
• created_at - Creation timestamp
• updated_at - Last update timestamp

Project Structure

gig-money-tracker/
├── main.cjs            # Main Electron process
├── preload.cjs         # Preload script for secure IPC
├── database.cjs        # Database management module
├── package.json        # Project configuration
├── package-lock.json   # Dependency lock file
├── webpack.config.cjs  # Webpack configuration
├── README.md           # Project documentation
└── src/
    ├── index.html          # Main HTML file
    ├── renderer.js         # Entry point for renderer process
    ├── App.jsx             # Root React component
    ├── styles.css          # Global styles
    └── components/
        ├── GigForm.jsx         # Form for adding/editing gigs
        ├── GigList.jsx         # List of gigs
        ├── Notification.jsx    # Notification component
        └── StatsGrid.jsx       # Financial stats grid

Usage

1. Adding a Gig: Fill out the form on the left side with gig details and click "Add Gig"
2. Viewing Gigs: All gigs are displayed on the right side with their status and amount
3. Editing Gigs: Click the "Edit" button on any gig to modify its details
4. Deleting Gigs: Click the "Delete" button to remove a gig (with confirmation)
5. Financial Overview: View your total earnings at the top

Data Storage

The application stores all data locally in a SQLite database file located in the user's application data directory:

• Windows: %APPDATA%/gig-money-tracker/gig-money-tracker.db
• macOS: ~/Library/Application Support/gig-money-tracker/gig-money-tracker.db
• Linux: ~/.config/gig-money-tracker/gig-money-tracker.db

Security

• Context isolation is enabled for security
• Database operations are handled through secure IPC channels
• No external network requests are made

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Test thoroughly
5. Submit a pull request

License

ISC License