SmartBudget

📗 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

📖 SmartBudget

The SmartBudget is a mobile web application where users can manage their budget: users have a list of transactions associated with a category, so that users can see how much money they spent and on what.

🛠 Built With

• Ruby
• Ruby on Rails
• VSCode
• Rubocop
• PostgreSQL

Tech Stack

Linters

• StyleLint
• Rubocop

Server

• Ruby

Database

• PostgreSQL

Key Features

• Add, delete, update, edit transactions
• Add, delete, update, edit transaction 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.

Setup

Clone this repository to your desired folder:

  cd PATH
  git clone https://github.com/KIsmoilov/SmartBudget

Install

Install this project with:

  cd SmartBudget
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rails db:create
  rails db:migrate
  rails db:seed
  rails db:seed RAILS_ENV=test
  rspec spec

(back to top)

👥 Authors

👤 Khusniddin Ismoilov

• GitHub: @KIsmoilov
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Save all transactions as pdf file

(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 star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the project idea

(back to top)

📝 License

This project is MIT licensed.

(back to top)