Skip to content

Web application that allows users to manage their income and expenses.

Notifications You must be signed in to change notification settings

shar0ff/Expense-tracker

Repository files navigation

Expense-tracker

Table of Contents

Description

Finance Tracker is a Ruby on Rails web application that helps users track and manage their income and expenses. It provides insightful analytics into financial habits, enabling users to categorize transactions and generate detailed expense reports. Whether you're looking to gain better control over your personal finances or manage a small business's accounts, Finance Tracker offers the tools you need to stay organized and informed.

Features

  • Income & Expense Tracking: Easily add, edit, and delete income and expense entries.
  • Categorization: Organize transactions into customizable categories.
  • Expense Reports: Generate detailed reports and visual charts to analyze spending habits.

Technologies Used

  • Backend: Ruby on Rails
  • Frontend: HTML5, CSS3, JavaScript, Bootstrap
  • Database: SQLite, PostgreSQL
  • Testing: Minitest
  • Deployment: Heroku

Installation

Follow these steps to set up the project locally:

  1. Clone the repository:

    git clone https://github.com/yourusername/finance-tracker.git
  2. Navigate into the directory:

    cd finance-tracker
  3. Install dependencies:

    bundle install
  4. Set up the database:

    rails db:create
    rails db:migrate
    rails db:seed

Usage

  1. Start the server:

    rails server
  2. Open your browser and go to:

    http://localhost:3000
    
  3. Add Categories:

    • Navigate to the "Categories" section to add categories for your future transactions.
  4. Add Transactions:

    • Navigate to the "Transactions" section to add your income and expenses.
    • Specify the amount, category, type and date for each transaction.
  5. View Reports:

    • Access the "Reports" section to view charts and summaries of your financial activities.
    • It is possible to generate reports both by categories and by dates for selected period of time.

Running Tests

  1. Ensure dependencies are installed:

    If you haven't already installed the gems, do so by running:

    bundle install
  2. Run all tests:

    You can run the entire test suite with:

    rails test
  3. Run specific tests:

    To run tests for a specific file:

    rails test test/models/example_model_test.rb
  4. Running tests with detailed output:

    If you want more detailed test output, you can run:

    rails test -v

Acknowledgements

Contact

Ivan Sharov
Email: [email protected] LinkedIn: Ivan Sharov