The Budget App

📗 Table of Contents

• 📗 Table of Contents
• 📖 The Budget App
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Explanatory Video
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ (OPTIONAL)
  • 📝 License

📖 The Budget App

The Budget App is a mobile web application designed for efficient budget management. With this app, users can register and log in to maintain their personal financial records. They can add new transactions associated with specific categories and gain insights into their spending patterns by tracking expenses within each category. The app adheres to best practices in Ruby development, follows a well-defined design inspired by Gregoire Vella's work on Behance, and ensures the security of user data through the use of authentication and input validation. The project also includes unit and integration tests for critical components, utilizes Postgres as the database, employs Devise for authentication, and provides thorough documentation, including a brief project video showcasing its features.

🛠 Built With

Tech Stack

Technologies

• Ruby on Rails

Linters

• Rubocop
• Style lint

Key Features

• User Registration and Authentication
• Category Management
• Transaction Logging
• Financial Summary
• Transaction History
• Transaction Logging
• Security and Data Validation
• Intuitive User Interface

(back to top)

💻 Explanatory Video

• Explanatory Video

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

You need ruby and bundler

Setup

Clone this repository to your desired folder:

sh
cd my-folder
git clone https://github.com/ClaudiaRojasSoto/BudgetApp.git

Install

Install this project with:

• gem install rails
• bundle install

Usage

To run the project, execute the following command:

rails server

Run tests

To run tests, run the following command:

rspec spec

(back to top)

👥 Author

👤 Claudia Rojas

• GitHub: @ClaudiaRojas
• LinkedIn: @ClaudiaRojas

(back to top)

🔭 Future Features

• Session History
• Currency Configuration
• Reports and Analysis
• Data Export

(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 please feel free to send me corrections for make it better I would feel glad to read your comments. And think If you enjoy gift me a star.

(back to top)

🙏 Acknowledgments

• Creative Commons license of the design and Gregoire Vella on Behance for her Original design idea.
• Microverse for providing the opportunity to learn Git and GitHub in a collaborative environment.
• GitHub Docs for providing a wealth of information on Git and GitHub.

(back to top)

❓ FAQ (OPTIONAL)

• Can I use with a templeate your project?

  • Of course I would feel honored

• Your project is free license?

  • Yeah, you can use it completely

(back to top)

📝 License

This project is licensed under the MIT License - you can click here to have more details MIT.

(back to top)