📗 Table of Contents

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

📖 CategorEASE App

CategorEASE is a comprehensive mobile web application designed to simplify expense tracking and budget management for individuals and households. It provides users with a user-friendly platform to efficiently categorize, monitor, and analyze their expenses, helping them make informed financial decisions.

🛠 Built With

Tech Stack

Ruby

• Ruby

Rails

• Rails

Rspec

• Rspec

Capybara

• Capybara

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

Setup

1. Ensure you have Ruby 3.2.2 at least, installed on your system. You can check your Ruby version in the terminal by running:

ruby -v

If Ruby is not installed, you can download and install it from the official Ruby website.

2. To get a local copy up and running, follow these steps. Choose the directory on your local machine where you want to copy project. For example:

cd /home/user/name-of-your-directory

Clone the project using one of the options.

Using SSH-key:

git@github.com:Alejuda/CategorEASE.git

Using HTTPS:

https://github.com/Alejuda/CategorEASE.git

Installation

To run this project locally, follow these steps:

1. Open your terminal or command prompt.

2. Navigate to the directory where you have cloned or downloaded the Recipe App repository.

3. Run the following command to install any required dependencies (in this case, we assume there are no external dependencies, so this step may not be needed):

bundle install

Usage

1. Once the setup is complete, ensure you are still in the directory containing the Recipe App files.

2. To run the app, execute the following command:

rails server

3.If you have future features like GUI or interactive mode, follow the specific instructions provided for those features in the app's documentation.

Tests

To run the tests ensure you are in the directory containing the test files.

1. Run the tests using the following command:

rspec

3. All tests should pass without any errors or failures, ensuring that the code and its methods are functioning correctly.

(back to top)

👥 Authors

👤 Ignacio Fino

• GitHub: @alejuda
• Twitter: @nacho_fino
• LinkedIn: Ignacio Fino

(back to top)

🔭 Key Features

• Expense Tracking
• Budget Management
• Transaction History
• Multi-Platform Access
• Secure User Accounts
• Data Visualization
• Authentication User
• Expense Reports

(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 give it a star ⭐️

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving us the opportunity to learn and grow as developers and also I like to thank my family, they are all my support. 🌟

Original Design Idea by Gregoire Vella

The design concept for this project was inspired by the work of Gregoire Vella, as originally shared on Behance. We greatly appreciate the creative input and vision provided by Gregoire Vella, which has contributed to the unique aesthetic and functionality of this project.

Author: Gregoire Vella Behance Profile

(back to top)

📝 License

This project is MIT licensed.

(back to top)