SMART BUDGET

📗 Table of Contents

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

📖 Smart Budget

Smart Budget 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. The Ruby on Rails application allows the user to:

• Register and log in, so that the data is private to them.
• Introduce new transactions associated with a category.
• See the money spent on each category.

🛠 Built With

Tech Stack

Client

• Ruby

Server

• Rails

Database

• PostgreSQL
• 

Other

• GitHub flow
• Rubocop
• Stylelint

Key Features

• [Create category to group transactions]
• [Create transaction with multiple categories]

(back to top)

📽️ Project Doocumentation

Here is a link to the video documentation of the project.

🚀 Live Demo

• Smart Budget

(back to top)

💻 Getting Started

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

Setup

Open the terminal and clone the project

 git clone [email protected]:MarcoOquendoC/Budget-app.git
 cd Budget-app

Prerequisites

In order to run this project you need: Git and Ruby

 gem install rails

Install

Install this project with:

  bundle install

  npm install

Create Database

• Modify config/database.yml line 6 with your postgres password

  rails db:create
  rails db:migrate
  rails db:seed

Usage

To run the project, execute the following command:

  rails tailwindcss:build
  rails s

Run tests

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

(back to top)

👥 Author

Marco Oquendo

• GitHub: @MarcoOquendoC.
• Twitter: @marcooquendoc.
• LinkedIn: Marco Vinicio Oquendo.

(back to top)

🔭 Future Features

• [Allow user to upload avatar]
• [Avoid the use of flowbite javascript]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Diego García

• Danys Linares

• Michael Mesfin

• Under the the Creative Commons license

• Original design from Gregoire Vella on Behance

(back to top)

📝 License

This project is MIT licensed.

(back to top)