Budget App

📗 Table of Contents

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

📖 The Budget App

The Budget App 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.

🛠 Built With

Tech Stack

This project was implemented using:

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• 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

🚀 Live Demo & Project Presentation

• Live Demo
• Project Presentation

(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 to have installed:

• You’ll need to have Ruby and Rails on your machine.

Optionally, in order to modify this project you should to have installed:

• Git.

• Code editor like: Visual Studio code, or others...

Setup

To clone this repository to your desired folder:

• You can download the Zip file from the GitHub repository, or clone the repository with:

git clone https://github.com/HunterX-7/Budget-App.git

• Access the cloned directory with:

cd Budget-App

• Open it with your favorite code editor or with the live server

Usage

It is require that you setup your database to run this project, check the config/database.yml and make sure that the username and password match you postgresql setup, then run:

rails db:create

rails db:migrate

To run the project, execute the following command in the project directory:

rails server

To run test, execute the following commands in the project directory:

rspec spec

(back to top)

👥 Authors

👤 Francisco Quintero

• GitHub: @HunterX-7
• Twitter: @franquin07
• LinkedIn: Francisco Quintero

(back to top)

🔭 Future Features

We will implement this on the future:

• Improve the user interface
• Improve the addition of new categories
• Improve the budget feature

(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

Original design idea by Gregoire Vella on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)