christianonoh / coin-mapper

CoinMapper is a user-friendly and intuitive budget management application designed to help you effortlessly navigate your financial journey. Effortlessly track expenses, map income, and master your finances. Start your journey to financial success today.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

logo
πŸ“— Table of Contents

πŸ’°πŸ“ˆ COINMAPPER

CoinMapper is a user-friendly and intuitive budget management application built with Ruby on Rails. This app is designed to assist you in effortlessly managing your finances, helping you track expenses, map income, and gain control over your financial journey. Start your path to financial success today with CoinMapper.

πŸ›  Built With

Tech Stack

Client
Server
  • LocalHost
Database

Key Features

  • Expense Tracking: Easily keep track of your expenses by categorizing and recording them within the app. This helps you gain insights into your spending habits and make informed decisions.

  • Budget Creation: Set up budgets for different categories, such as groceries, entertainment, utilities, and more. Stay within your budget limits and monitor your spending in real-time.

  • User-Friendly Interface: CoinMapper is designed with simplicity in mind. The intuitive interface ensures that users of all levels can navigate and utilize the app without any hassle.

  • Customizable Categories: Tailor expense categories to suit your unique spending patterns. Create, edit, or delete categories to match your preferences.

  • Secure Authentication: Your financial information is kept safe with robust user authentication and data encryption measures.

(back to top)

πŸš€ Live Demo & Video presentation

In the video, we provide a walkthrough of the application, demonstrating how to create Categories and Expenses, modify them as you see fit and navigate the responsive design on different devices.

(back to top)

πŸ’» Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Ensure you have Ruby installed on your system. You can check by running the code below in your terminal.

  ruby --version

Setup

Clone or download the Coin Mapper repository to your local machine.

  git clone https://github.com/christianonoh/coin-mapper.git

Open your terminal and navigate to the cloned project directory.

Install

  • This project does not require additional dependencies, just Ruby interpreter. However, it uses RuboCop as a linter and you should set it up as well.
bundle install
  • Database Setup: Navigate to the project directory and set up the database.
rails db:create
rails db:migrate

Usage

  • Start the Rails server to run the application locally.
  rails server

Open your web browser and go to http://localhost:3000 to access CoinMapper.

Running Tests

CoinMapper uses RSpec for testing. To run the tests, follow these steps:

  • Navigate to Project Directory: Make sure you are in the project directory (coin-mapper).

  • Run Tests: Use the following command to run the tests.

  rspec
  • This will execute all the tests in the spec directory and provide you with the results.

(back to top)

πŸ‘₯ Authors

πŸ‘€ Christian Onoh

(back to top)

πŸ”­ Future Features

  • Visual Reports: Gain deep insights into your financial health with visual reports and graphs. Monitor trends, identify opportunities for saving, and make informed decisions.
  • Income Mapping: Keep a clear record of your income sources. Whether it's your salary, freelancing gigs, or passive income, CoinMapper helps you visualize and manage your earnings.

(back to top)

🀝 Contributing

We're committed to continuously improving CoinMapper. If you encounter any issues or have suggestions for improvement, please submit an issue.

(back to top)

⭐️ Show your support

If you enjoy using CoinMapper, please consider supporting us to help keep the app free and accessible for everyone. Thanks for your support!

(back to top)

πŸ™ Acknowledgments

Original design idea by Gregoire Vella.

(back to top)

πŸ“ License

This project is MIT licensed.

(back to top)

About

CoinMapper is a user-friendly and intuitive budget management application designed to help you effortlessly navigate your financial journey. Effortlessly track expenses, map income, and master your finances. Start your journey to financial success today.

License:MIT License


Languages

Language:Ruby 68.5%Language:HTML 22.8%Language:SCSS 7.1%Language:JavaScript 1.4%Language:Shell 0.2%