📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🔭 Project Presentation
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Budget Tracker

A web application where you can manage your budget: you have a list of transactions associated with a category, so that you can see how much money you spent and on what.

🛠 Built With

Tech Stack

Client

• Bootstrap
• JavaScript

Server

• Ruby on rails

Database

• PostgreSQL

Key Features

• [authentication system to allow login and registration]
• [list categories of items you spend on]
• [list transactions for a specific category]

(back to top)

Project Presentation

• Video

(back to top)

Live Demo

• BudgetTracker

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need followed installed on your computer:

• Ruby v3+,
• Rails v7+
• PostgreSQL
• An IDE e.g Visual studio code.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

git clone https://github.com/devMunyi/Budget-Tracker

• Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd Budget-Tracker

Install

To install all dependencies, run:

bundle install

Database Setup

• Create .env file and add the following three lines(be sure to replace with your details):

DB_HOST='localhost'
DB_USERNAME='your_postgress_username'
DB_PASSWORD='your_postgress_password'

• Then run the following command:

rails db:create db:migrate

Usage

To run the project, follow these instructions:

• To get it running on your machine, you may open the project on your IDE and open the terminal
• On the terminal you can run:

rails s OR rails server

Run tests

• To run rubcop tests, run the following command:

rubocop

• To run rspec tests, run the following command:

rspec

(back to top)

👤 Authors

👤 Samuel Munyi

• GitHub: @devMunyi
• LinkedIn: Samuel Munyi
• Twitter: @munyi_sam

(back to top)

🔭 Future Features

• Implement more methods and features.
• Improve the UI.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project and how I managed to build it!

(back to top)

🙏 Acknowledgments

• The original design idea by Gregoire Vella on Behance.
• Project from Microverse Ruby on Rails module.
• Thanks to the Microverse team for the great curriculum.
• Thanks to the Code Reviewer(s) for the insightful feedbacks.
• A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
• Hat tip to anyone whose code was used.

(back to top)

❓ FAQ

• Can I fork and reuse the repository

  • Yes please, feel free.

• Can I improve the repository, and my changes will be accepted if they are good?

  • Yes please, nice ideas are welcome, please.

(back to top)

📝 License

This project is MIT licensed.

(back to top)