📗 Table of Contents

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

Budget App

Full React rails app

🛠️ Built With

Tech Stack

Client

• HTML
• CSS

Backend

• Rails

Database

• PostgreSQL

Key Features

• Record a transaction
• Associate a transaction with a category
• Create new categories
• View amount spent on each category

(back to top)

🚀 Live Demo

• Live Demo

(back to top)

💻 Getting Started

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

Prerequisites

You need the following tools be installed in your computer:

• Rails
• Git
• Ruby
• IDE

Setup

Clone this repository to your desired folder:

  cd my-prefered-folder

  git clone https://github.com/faisalakb/Budget-app-Capstone.git

### Install

Install this project with:<br>

```sh
  cd BudgetApp

  bundle install

Database

Create the databases and run migrations with:

rails db:create
rails db:migrate

Usage

To run the project, execute the following command:

  rails server or rails s

Run tests

To run tests, run the following command:

  rspec spec/

(back to top)

👥 Authors

👤 Faisal Mumtaz

• GitHub: @faisalakb
• Twitter: @faisalakb786
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Record income
• Add more category options
• View monthly savings
• Improve styling

(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 give it a star.

(back to top)

🙏 Acknowledgements

• Thanks to Gregoire Vella for the UI/UX design.
• Thanks to my coding partners for their support

(back to top)

📝 License

This project is MIT licensed.

(back to top)