📗 Table of Contents

• 📗 Table of Contents
• 📖 [BudgetWizard]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
    • Video documentation 📹
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 [BudgetWizard]

BudgetWizard is a web application designed to help users manage their personal finances. Users can create a budget, track their expenses, and receive helpful insights into their spending habits. The application utilizes a simple and intuitive interface that allows users to easily view and manage their finances. The application is built using Ruby on rails on the server side, and a PostgreSQL database to store user information. BudgetWizard is designed to provide users with a reliable and easy-to-use tool to help them gain better control over their finances.

🛠 Built With

Tech Stack

Programming Language

• Ruby

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User authentication and authorization
• Category (group) creation
• Transactions creation

(back to top)

🚀 Live Demo

• Live Demo Link

Video documentation 📹

• Video documentation

(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 Ruby and Ruby on Rails installed, you can install rails with the following command:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:myaccount/BudgetWizard.git

Install

Install this project with:

  cd my-project
  bundle install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec

Deployment

You can deploy this project using (you need to register in Fly.io):

  fly launch
  fly deploy

(back to top)

👥 Authors

👤 Author1: Oscar Fernández Muñoz

• GitHub: @OscarFMdev
• Twitter: @OscarFMdev
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Mailing conirmation in development
• Improve UI
• Add searching functionality

(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 kindly give it some stars

(back to top)

🙏 Acknowledgments

I would like to thank:

• Original design idea by Gregoire Vella on Behance.
• Aprendev for explaining concept in a simple way.

(back to top)

📝 License

This project is MIT licensed.

(back to top)