📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements

Budget-App

Budget-App is a full-stack web application developed using Ruby on Rails. It provides user authentication with login and logout functionality, allowing users to securely access their data. With Budget-App, users can add categories to organize their expenses and incomes, and then add transactions for each category to keep track of their spending. The application also features a modern and visually appealing design that enhances the user experience. The design was created by Gregoire Vella on Behance, a highly acclaimed designer whose portfolio is showcased on Behance.

🛠 Built With

Tech Stack

Developed using Ruby on Rails.

Languages

• Ruby

• Rails

Key Features

• Register and login features
• Database where you can add categories and transactions
• Implemented design from the sneak peek wireframe

🚀 Live Demo

• Coming soon!

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• You need to have ruby on rails installed in your computer.

Setup

Clone this repository to your desired folder:

- To clone the repository run this command - "git@github.com:taldr27/BudgetApp.git" OR "https://github.com/taldr27/BudgetApp.git"
- cd budgetapp

Installation

Install this project with:

- bundle install
- rails secret
- EDITOR="mate --wait" bin/rails credentials:edit
- bundle exec rails assets:precompile

Use // app/javascript/*.* in build script in case of error when compiling the assets

Usage

To run the project, execute the following command:

- rails server

Run tests

To run tests, run the following command:

- rspec

👥 Authors

👤 Diego Garcia

• GitHub: @taldr27
• LinkedIn: diegogarcial

🔭 Future Features

These are some of the future features we want to add.

• Add a remove button for categories
• Add a remove button for each transaction
• Add a all transactions page

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

⭐️ Show your support

Give a ⭐️ if you like this project!

🙏 Acknowledgments

I would like to thank to the code reviewers and my partners who are helping all the time. Based on the original idea of Gregoire Vella on Behance.

📝 License

This project is MIT licensed.

(back to top)