https://github.com/booze33/budget-app

Last synced: 22 days ago
JSON representation

Host: GitHub
URL: https://github.com/booze33/budget-app
Owner: Booze33
License: mit
Created: 2023-08-07T09:40:18.000Z (almost 3 years ago)
Default Branch: dev
Last Pushed: 2023-08-10T13:28:27.000Z (almost 3 years ago)
Last Synced: 2025-02-25T22:16:53.877Z (over 1 year ago)
Language: Ruby
Size: 9.76 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 📗 Table of Contents

📗 Table of Contents

📖 Budget App

🛠 Built With

💻 Getting Started

👥 Authors

🔭 Future Features

🤝 Contributing

⭐️ Show your support

🙏 Acknowledgments

📝 License

# 📖 Budget App

**Budget App** is a Ruby on Rails project designed to help you monitor you spending habits. Go ahead and sign up to start organizing your transactions, monitoring your total spend and keeping track of your budget.
![image](https://github.com/Booze33/budget-app/assets/99689722/89631a5b-54ea-419d-8c7c-48b12701dc76)

## 🛠 Built With

### Tech Stack

Client

HTML

Server

Ruby

Rails

Database

PostgreSQL

### Key Features

- User authentication
- Users can create and view transaction categories
- Users can create and view transactions
- Users can monitor total spend on each category

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://budgetapp-v6n9.onrender.com)
- [Video Documentation](https://www.loom.com/share/e8b880927021464c85eea4e8813099ca?sid=c02f61e8-a033-4c45-bf32-ff4ef1ddc891)

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

```sh
git
bundle
Your favorite text editor
```

### Setup

Clone this repository to your desired folder:

```
https://github.com/Booze33/budget-app.git
```

### Install

Install this project with:

```sh
cd budget-app
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails server - Starts the development server
rails console - Starts the interactive command line
```

### Run tests

To run tests, run the following command:

```sh
rspec - Runs the test suite
```

(back to top)

## 👥 Authors

👤 **Tebe Tisloh**

- GitHub: [@Booze33](https://github.com/Booze33)
- Twitter: [@twitterhandle](https://twitter.com/Tebe95645832)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/tebe-tisloh-847956225)

(back to top)

## 🔭 Future Features

- [ ] Add a feature to allow users to follow other users

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

If you like this project please leave a star🤩

(back to top)

## 🙏 Acknowledgments