luigirazum/money-compass

MoneyCompass is a mobile web application where you can manage your budget. You have a list of payments associated with a category, so that you can see how much money you spent and on what. It allows you to register and log in to keep the data private, introduce new categories and payments and see the money spent on each category. Give it a try!

About

MoneyCompass is a mobile Budget Application where you can manage your budget. See more...

---

📗 Table of Contents

• 💬 About the project
  • 🛠 Built With
    • Tech Stack
  • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Usage
  • Run
  • Open
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

---

💰MoneyCompass

🤷‍♂️ MoneyCompass is a mobile Budget Application where you can manage your budget.
📃 You have a list of Payments associated with a Category, so that you can see how much money you spent and on what.
👤 It allows you to register and log in to keep the data private, introduce new categories and new payments and see the money spent on each category.
🧑‍💻 It's a fully functional web app created with Rails.
💾 All the data is preserved using a PostgreSQL Database.

• Building the MoneyCompass App

  It follows the next ERD data model:

  

  This project keep the following Design Guidelines:

  

  

  Original design idea by Gregoire Vella on Behance.

  This project is made to prove our knowledge and learn more about Ruby on Rails concepts - starting from the Views and finishing the database connection. We will also implement ideas like authentication, authorization, and testing.

🛠 Built With

• Tech Stack

  • Ruby
  • Rails
  • PostgreSQL

• Key Features

  MoneyCompass users will be able to:

  • Create Categories to group their payments.
  • Create Payments for a given Category.
  • List their Categories and Payments.
  • Register in the app with an email and password.
  • Log in the app so only the user can see their categories and payments.

(back to top)

🚀 Live Demo

• MoneyCompass Live Demo

(back to top)

💻 Getting Started

To get a local copy of this project up and running, follow these steps.

• Prerequisites

  • git installed. Please got to Getting Started - Installing Git guide and follow the steps described for your system to install git.
  • Ruby installed, you can go to the Installing Ruby documentation and follow the steps for your computer OS.
  • Rails installed, you can follow the GoRails Tutorial and follow the steps for your computer OS.
  • PostgreSQL installed, you can follow the PostgreSQL Tutorial and follow the steps for your computer OS.

• Setup

  Clone this repository to your local-folder:

  cd local-folder
  git clone git@github.com:luigirazum/money-compass.git

• Usage

  In the local-folder where you cloned the project, go into the project folder

  cd money-compass

• Prepare

  In the money-compass folder, use the following code to install the app dependencies

  bundle install

• Run

  In the money-compass folder, use the following code to run the app

  rails server

• Open

  Open your favorite browser and type in the address bar

  http://localhost:3000

(back to top)

👥 Author

👨‍💻 Luis Zubia

• @luigirazum
• @LuigiRazum
• /luiszubia

(back to top)

🔭 Future Features

• Delete a Category or Payment previously created.
• Download all the Payments and Categories.
• Edit a Payment so it can be associated with another Category.

(back to top)

🤝 Contributing

Contributions, issues, typos, and feature requests or suggestions are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project, I will really appreciate your support, and don't forget to give a ⭐ to this repository.

(back to top)

🙏 Acknowledgments

• I would like to thank Yukihiro “Matz” Matsumoto for creating the Ruby Programming Language.
• Thanks David Heinemeier Hansson for sharing Rails to the world.
  Wikipedia: Ruby on Rails - History
• Also thanks to Gregoire Vella on Behance for his original idea on the Design Guidelines used in this project under the CreativeCommons CC BY-NC 4.0 Deed License.
• Last but not least, thanks to the amazing Microverse community.

(back to top)

📝 License

This project is MIT licensed.

(back to top)