Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/metaverse-nabeel/cash-byte

The Ruby on Rails capstone project "Cash Byte" is about building 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/metaverse-nabeel/cash-byte

Last synced: 16 days ago
JSON representation

The Ruby on Rails capstone project "Cash Byte" is about building 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

        

# Cash Byte ![Rails](https://rubyonrails.org/assets/images/logo.svg)

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [Entity Relationship Diagram](#entity-relationship-diagram)
- [🚀 Live Version](#live-version)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database](#database)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)

# 📖 Cash Byte

**Cash Byte** The Ruby on Rails capstone project "Cash Byte" is about building 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

Client

Server




Database

### Key Features

- Login page.
- Registration page.
- Category page.
- Deals page (showing expense against a particular category)
- All Categories page (all categories and total amount).

## Entity Relationship Diagram

![](./app/assets/images/erd_diagram.png)

(back to top)

## 🚀 Live Version

- [Comming Soon]()

(back to top)

## 🚀 Presenation video

- [Video](https://www.loom.com/share/0b8961eb4d9941e787fc6f6103b9bee7?sid=68f380bf-a0ff-43ed-9c22-7497a250041f)

(back to top)

## 💻 Getting Started

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

### Prerequisites

In order to run this project you need:

- [Ruby](https://www.ruby-lang.org/en/) installed and running
- [Rails](https://rubyonrails.org/) installed and running
- [PostgreSQL](https://www.postgresql.org/) installed and running

### Setup

Clone this repository to your desired folder:

```
git clone https://github.com/Metaverse-Nabeel/cash-byte.git
cd cash-byte
code .
```

### Install

Install the project dependencies, execute the following command in Bash:

```sh
bundle install
```

### Database

Create the database, execute the following command in Bash:

```sh
rails db:create
rails db:migrate
```

### Usage

To run the project, execute the following command in Bash:

```sh
rails server
```

### Run Tests

To run the project tests, execute the following command:

```sh
rspec spec
```

(back to top)

## 👥 Author / Owner

👤 **Nabeel Ahmed**
- GitHub: [@Metaverse-Nabeel](https://github.com/Metaverse-Nabeel)
- LinkedIn: [@Nabeel129](https://www.linkedin.com/in/nabeel129/)
- Wellfound(AngelList): [@Nabeel129](https://wellfound.com/u/nabeel-ahmed-62)

(back to top)

## 🔭 Future Features

- Making desktop view
- Impoving UI / UX of the application
- Improving Navigation

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/Metaverse-Nabeel/cash-byte/issues).

(back to top)

## ⭐️ Show your support

Give a start if you like this project!

(back to top)

## 🙏 Acknowledgments

- I would like to thank the Microverse program!

(back to top)

## 🙏 Credits

- I would like to give credit for Original design idea to [Gregoire Vella on Behance](https://www.behance.net/gregoirevella).!

(back to top)

## 📝 License

This project is [MIT](./LICENSE.md) licensed.

(back to top)