Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iamsjunaid/budget-bee

budget bee 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.
https://github.com/iamsjunaid/budget-bee

postgres rspec ruby-on-rails tailwind

Last synced: 21 days ago
JSON representation

budget bee 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.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Budget bee ](#-budget-bee-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#deployment)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 budget bee

**budget bee** 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

Server

Database

### 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.**

(back to top)

## 🚀 Live Demo

- [Live Demo Link](https://budget-bee.onrender.com)

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

- `Text Editor (VSCode, RubyMine)`
- `Ruby`

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/iamsjunaid/budget-bee.git
```

### Install

Install this project with:

```sh
cd my-project
bundle install
```

### Usage

To run the project, execute the following command:

```sh
rails server
```

### Run tests

To run tests, run the following command:

```sh
rspec spec
```

### Deployment

You can deploy this project using your own deployment service like `Render`.

(back to top)

## 👥 Authors

👤 **Junaid A Syed**

- GitHub: [@iamsjunaid](https://github.com/iamsjunaid)
- LinkedIn: [LinkedIn](https://linkedin.com/in/junaidahmedsyed)

(back to top)

## 🔭 Future Features

- [ ] **Upload icons as files**
- [ ] **Add location attribute to be saved for each purchase**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/iamsjunaid/budget-bee/issues).

(back to top)

## ⭐️ Show your support

If you like this project consider adding a ⭐️

(back to top)

## 🙏 Acknowledgments

- I would like to thank Microverse.
- I would like to give credit to [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) the [author of the original design](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=), for the inspirational source of this project as required by the [Creative Commons license of the design](https://creativecommons.org/licenses/by-nc/4.0/).

(back to top)

## 📝 License

This project is [MIT](https://github.com/iamsjunaid/budget-bee/blob/dev/LICENSE) licensed.

(back to top)