Budget App

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Budget App]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👤 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [Budget App]

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

• Tailwind

Server

• ROR

Database

• PostgreSQL

Key Features

• [Create Category]
• [Edit Category]
• [Create Transaction for the category]
• [Edit Transaction for the category]
• [See the total expense spent on each category]

(back to top)

🚀 Live Demo

• Live Demo Link

• Video Presentation

(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 version - ruby 3.1.2 
  Rails version - Rails
  Chrome Browser 
  Vscode Optional

Setup

Clone this repository to your desired folder:

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

Install

Install this project with:

  Run bundle install 
  Run rails db:create
  Run rails db:migrate

Usage

To run the project, execute the following command:

  run bin/dev or /bin/dev  
  

Run tests

To run tests, run the following command:

  To Run all tests - rspec
  To Run model tests - rspec spec/models
  To Run integration tests - rspec spec/views

(back to top)

👤 Author

👤 Miliyon Ayalew

• GitHub: @Miliyonayalew
• Twitter: @Miliyonayalew
• LinkedIn: Miliyonayalew

🔭 Future Features

• [implement some UX improvements: include transitions and/or animations, etc.]
• [Make sure that you have a decent desktop design for the webapp.]
• [Implement the left side menu to improve the navigability of the 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

If you like this project or you learned something from it, please give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank the following people for their support and guidance:

• Microverse

• Original design idea by Gregoire Vella

• Code Reviewers

(back to top)

📝 License

This project is MIT licensed.

(back to top)