anita00001 / budget-app

Budget App

📗 Table of Contents

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

📖 BUDGET BUDDY

A BUDGET BUDDY 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.

To know more about the app, watch this Video Presentation !

Live Demo Link of the app !

ER Diagram of the Project

🛠 Built With

Tech Stack

This application is built on Ruby on Rails and PostgreSQL as a Database.

Ruby

• Ruby - A Programmer's Best Friend

Ruby on Rails

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Register and Log In, so that the data is private
• Introduce new transactions associated with a category
• See the money spent on each category
• Able to add a new category
• Able to add a new transaction

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

• Download and Install Ruby for your OS.
• Download and Install PostgreSQL
• VS Code
• Ruby on Rails

  gem install rails

Setup

Clone this repository to your desired folder:

  git clone https://github.com/anita00001/budget-app.git

  cd budget-app

Install

Install this project with:

  gem install

  bundle install

Usage

To run the project, execute the following command:

• Drop the previously existing database of same name

  rails db:drop

• Create database and Migrate

  rails db:create db:migrate

• Feed Sample data through seeds

  rails db:seed

• Run the server

  rails server

Run tests

• To run Rubocop checker, run the following command:

  gem install rubocop

  rubocop

• To run Stylelint checker, run the following command:

  npm install

  npx stylelint "**/*.{css,scss}"

👥 Authors

👤 Anita Sharma

• GitHub: @anita00001
• LinkedIn: anitaa-sharmaa
• Twitter: @anitaa_sharmaa

(back to top)

🔭 Future Features

• UX improvements: transitions and/or animations
• 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, you can appreciate us by giving star ⭐

🚀 Follow us on GitHub, LinkedIn, and Twitter 🙏🤗

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for providing this opportunity to build this project. Also, I extend my sincere gratitute to Code Reviewers who encourage and support to build this application more effieiently.

CC Licenses: I would thank Gregoire Vella for the original design idea.

(back to top)

📝 License

This project is MIT licensed.

(back to top)