Budget App README

📗 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
• ❓ FAQ (OPTIONAL)
• 📝 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

Tech Stack

Client

• Ruby on Rails
• CSS
• HTML

Database

• PostgreSQL

Key Features

User will be able to

• register and log in, so that the data is private to them.
• introduce new transactions associated with a category.
• see the amount spent on each category.

(back to top)

Live Demo

Click to checkout the live demo app

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

• A text editor preferably Visual Studio code
• Latest version of Ruby installed
• PostgreSQL Server

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:Fayob/budget-app.git
  cd budget-app

Install

Install this project with:

  gem install

Usage

To run the project, execute the following command in your terminal:

  rails server

Open your browser and go to "http://localhost:3000/" to see the working project

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Author

👤 Abimbola Favour

• GitHub: @fayob
• Twitter: @fabimworld
• LinkedIn: abimbola-ade

(back to top)

🔭 Future Features

• A better design to user interface
• A Better information validation
• A backend API to serve as many frontend as possible

(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, please leave a star 😁

(back to top)

🙏 Acknowledgments

I would like to give kudos to Gregoire Vella on Behance for making the design which was used for this project.

(back to top)

❓ FAQ (OPTIONAL)

• Can I reuse this code?

  • Yes, feel free to fork it

• Do I need knowledge of Ruby to use this project?

  • No you do not.

(back to top)

📝 License

This project is MIT licensed.

(back to top)