Budget App

📗 Table of Contents

• 📗 Table of Contents
• 📖 Catalog of my things
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Dependencies
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Budget App

Fully functional budget application that allows a user to add categories and transactions to their list.

🛠 Built With

Tech Stack

Server

• Ruby (v3.2.2)
• Ruby on Rails (v7.0.5)

Database

• PostgreSQL

Live Preview

You can preview the project by visiting the link below

Link Preview

Description

You can watch a demo of the video description below.

Link to Loom.

Key Features

• Registered users will be able to create new category.

• Users will be able to create a transaction entity from the category chosen

• Users will be able to go back to home.

(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:

1. Ruby installed on your machine
2. Text editor (VSCode, Sublime, Atom, etc.)
3. Install Rails gem.
4. PostgreSQL running on your machine

Setup

Clone this repository to your desired folder:

  git clone https://github.com/calebchris000/Budget-App.git
  cd Budget-App

Dependencies

Install Dependencies with:

  bundle install

create database in your postgresql with:

  rails db:create

Note: If you have any problem with the database, you can check the database.yml file and change the username and password to your own.

Run migration with:

  rails db:migrate

Usage

Run Project with:

  rails server

Run tests

Run tests with:

  rspec

(back to top)

👥 Authors

👤 Caleb Nwaizu

• GitHub: @calebchris000
• LinkedIn: @calebchris000

(back to top)

🔭 Future Features

• Add Authentication page

(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, please leave a ⭐️

(back to top)

🙏 Acknowledgments

I will use this medium to appreciate Georgoire Vella, who is the source of the inspiration for the UI of the application. I also feel thankful for Microverse for investing in my career.

(back to top)

📝 License

This project is MIT licensed.

(back to top)