Mausi Budget - MONEY MOVES

📗 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
• 📝 License

📖 Money moves

This is a mobile web application, which allows users to control their budgets. The user can divide the budget into different categories and insert the expenses that have been made in the categories.

🛠 Built With

Tech Stack

Client

• Ruby on Rails

Server

• Render

Database

• PostgreSQL

Key Features

• List all budget's categories.
• List all transactions that belongs to one category.
• Add a new category.
• Add a new transaction.

(back to top)

🚀 Live Demo

• Video Documentation

• Live Demo Link

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

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Feliverse/MausiBudget.git

Install

Install this project with:

  cd my-project
  bundle install

Usage

This project use Tailwind, so to run the project, execute the following command:

  bin/dev

Run tests

To run tests, run the following command:

  rails spec

Deployment

You can deploy this project using:

  rails server

(back to top)

👥 Author

👤 Felipe Haybar

• GitHub: @Feliverse
• Twitter: @FelipeHaybar
• LinkedIn: FelipeHaybar

(back to top)

🔭 Future Features

• Images to choise by default
• Navigator with find option
• Calculator page

(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 star if you like this project!

(back to top)

🙏 Acknowledgments

• This project's styles are based on the design by Gregoire Vella.
• Microverse.

(back to top)

❓ FAQ

• Why bin/dev instead of rails server?

  • The commend bin/dev not only start your server, it also builts your Tailwind CSS classes to give the styles.

• What is current_user?

  • This is a built-in method of Devise which help to get the user who is currently loged in the app.

(back to top)

📝 License

This project is MIT licensed.

(back to top)