README.md

**Budget App**

📗 Table of Contents

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

📖 [Budget App]

[Budget App] is based on Ruby Language and Rails framework.

Project Video Link: Click Here

Deployed Link: Click Here

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Localhost

PostGre SQL

• N/A

Key Features

• [A user can create list of restaurants]
• [A user can add food items that in which restaurant he ate that food]
• [A user can keep record of how much money he has spent on food items]
• [Devise is used for Authentication]
• [CanCanCan is used for Authorization]
• [Tests have been made using capybara and rspec]
• [Postgresql is used]

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Ruby and Ruby on Rails

Setup

Clone this repository to your desired folder:

cd budget app
git clone https://github.com/zunairkhan811/budget-app.git

Install

Install this project with:

bundle install

Usage

To run the project, execute the following command:

rail s

Run tests

Run:

rspec spec

(back to top)

👥 Author

👤 Muhammad Zunair khan

• GitHub: @zunairkhan811
• Twitter: @zunairkhan811
• LinkedIn: @mzunairkhan

(back to top)

🔭 Future Features

• [Will add more features in the app]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the repo

(back to top)

⭐️ Show your support

If you like my project kindly comment or Follow me on LinkedIn, Twitter & twitter and always Your feedback will be really appreciated. Thanks!

(back to top)

🙏 Acknowledgments

I would like to give credit to the author of this Design according to License Agreement

(back to top)

❓ FAQ (OPTIONAL)

• [What is Budget App?]

  • [In this project, a user can keep record of money spent on food items and can keep record of list of restaurants he visited and number of food items he ate and can know how much total money is spent on any restaurant he visited. ]

(back to top)

📝 License

This project is MIT licensed.

(back to top)