📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • 📹 Video Description
    • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Available Scripts
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

Budget App

Budget App is a software application that you can access from your computer, tablet or mobile device to track your finances, such as income, savings, debt payoff, or investing. Budget apps can help sync with your financial accounts to give you an overview in real-time when finances change.

Built With

Tech Stack

• Ruby 3.1
• Ruby on Rails 7
• PostgreSQL 15

Key Features

• User registration system (using Devise gem)
• User authorization system to manage permissions and access control (using CanCanCan gem)

Video Description

• Watch a video description given by me

Live Demo

• Access the live version here

Getting Started

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

Prerequisites

• Ruby
• Ruby on Rails
• PostgreSQL
• any code editor

Setup

To setup the project follow the steps:

1. Clone this project using Git Bash:

   git clone https://github.com/adnanolarmmi/budget-app 
   

2. Inside the project directory, install the project's dependencies

   bundle install
   

3. Setup the app's database

   rails db:setup
   

Available Scripts

In the project directory, you can run:

• rails server
  

  Runs the app server

• rubocop
  

  Launches the test runner.

Author

👤 Is-haq, Adnan Olamilekan

• GitHub: @AdnanOlarmmi
• Twitter: @AdnanIshaqOla
• LinkedIn: Adnan (Olamilekan) Is-haq

Future Feature

• Implement user engagement features (likes, comments and ratings)

Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

If you like this project give it a star!

Acknowledgments

• Microverse

License

This project is MIT licensed.