📗 Table of Contents

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

📖 [Budget-App]

[Budget-App] is 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 Ruby on Rails

Tech Stack

• Ruby
• Rails
• PostgreSQL

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• [Login/ Registration page]
• [Categories page]
• [Transactions page]

(back to top)

🚀 Live Demo

• Live demo link

(back to top)

💻 Video Demo

• Video 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 on your computer. Download Ruby via the official website
• Install rails. Run gem install rails
• You also need to have PostgreSQL installed

Setup

Clone this repository to your desired folder:

• git clone git@github.com:oguntayomicheal/Budget-App.git
• cd Budget-App/

Install

Install this project with:

• run bundle install to install necessary gems

Usage

To run the project, execute the following commands:

• rails db:create db:migrate
• rails s
• On your browser, type localhost:3000 to see the app

Run tests

To run tests, run the following command:

• rspec spec

(back to top)

👥 Authors

👤 Micheal Oguntayo

• GitHub: @oguntayomicheal
• Twitter: @OguntayoMicheal
• LinkedIn: @OguntayoMicheal

(back to top)

🔭 Future Features

• [Implement destroy functionality for a transaction]
• [Implement edit and update functionalities for both the category and transaction]
• [Add tablet and desktop styles to the web app]

(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 this project a ⭐️ if you like it.

(back to top)

🙏 Acknowledgments

• This design was an inspiration by Gregoire Vella on Behance, the author of the original design.
• Hat tip to Microverse for the guidance and provision of Ruby on Rails learning materials.

(back to top)

📝 License

This project is MIT licensed.

(back to top)