bushush/budget-app

A mobile 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.

Microverse README Template

📗 Table of Contents

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

📖 My Budget App

A mobile 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

This project was built using.

Client

• Bootstrap
• HTML
• CSS

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

key features of the application.

• User can register and login
• Authenticated User can manage transactions and categories

(back to top)

🚀 Live Demo

• Live Demo Link

(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:

• Ruby installed
• Postgresql installed
• Git installed [ In case you want to clone this repo using your terminal]
• Any IDE or text editor that supports Ruby

Setup

Clone this repository to your desired folder:

1. Clone this repository or download the Zip folder:"

$ git clone https://github.com/bienvenuushindi/budget-app.git

2. Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd <folder>

3. Press Enter to navigate to your local clone.

4. Install the gems:

bundle install

5. Create database and run the necessary migration files :

$ bin/rails db:create
$ rake db:migrate

6 Finally you can run the server:

rails s

(back to top)

👥 Authors

👤 Ushindi Bienvenu

• GitHub: @usbbush
• LinkedIn: @usbbush

(back to top)

🔭 Future Features

• Implement API for this application
• Implement Transactions details page

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, Kindly give it a ⭐

(back to top)

🙏 Acknowledgments

I would like to thank the Ruby community and Microverse team

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)