https://github.com/itsmraga-hub/budget-app

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/itsmraga-hub/budget-app

html5 postgresql ruby ruby-on-rails

Last synced: about 1 month ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/itsmraga-hub/budget-app
• Owner: itsmraga-hub
• License: mit
• Created: 2022-12-19T08:09:41.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-13T08:00:15.000Z (almost 2 years ago)
• Last Synced: 2024-10-03T14:23:21.790Z (about 2 months ago)
• Topics: html5, postgresql, ruby, ruby-on-rails
• Language: Ruby
• Homepage:
• Size: 858 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




  

  


  
Budget app




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 [Budget app] 

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

**[Budget app]** is a mobile web application where you can manage your budget.

## 🛠 Built With 

### Tech Stack 

> Describe the tech stack and include only the relevant sections that apply to your project.

  Client

  


    
React.js

    
HTML

    
CSS

  


  Server | Backend

  


    
Ruby on rails

  


Database

  


    
PostgreSQL

  


Images

![Screenshot](./image-1.png)

![Screenshot](./image-2.png)


### Key Features 

> Describe between 1-3 key features of the application.

- **[See overview of money spent]**

  - See the money spent on each category.

- **[Add Transactions and categories]**

  - Introduce new transactions associated with a category or multiple categories.

- **[Sign in and sign up]**

  - User authentication. Such that the data is private to user currently logged in.

(back to top)


## 🚀 Live Demo 

> Add a link to your deployed project.

- [Live Link](https://cashverse-raga.onrender.com/)

- [Loom video](https://www.loom.com/share/fa994de927394858b0a81204dafdb1c4)

(back to top)


## 💻 Getting Started 

> Describe how a new developer could make use of your project.

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

### Prerequisites

In order to run this project you need:

```sh

 gem install rails

```

### Setup

Clone this repository to your desired folder:

```sh

  cd folder

  git clone https://github.com/itsmraga-hub/budget-app.git

  cd budget-app

  Open in your favorite editor

```

### Install

Install this project with:

```sh

  cd budget-app

  gem install

  bundle install

```

### Usage

To run the project, execute the following command:

```sh

  rails server

```

### Run tests

To run tests, run the following command:

```sh

  bin/rspec spec

```

### Deployment

You can deploy this project using:

(back to top)


## 👥 Authors 

> Mention all of the collaborators of this project.

👤 **William Raga**

- GitHub: [@itsmraga-hub](https://github.com/itsmraga-hub)

- Twitter: [@RagaMacharia](https://twitter.com/RagaMacharia)

- LinkedIn: [William Raga](https://linkedin.com/in/itsmraga)

(back to top)


## 🔭 Future Features 

> Describe 1 - 3 features you will add to the project.

- [ ] **[List Transactions]**

- [ ] **[Transaction Details]**

(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 

> Write a message to encourage readers to support your project

If you like this project...

(back to top)


## 🙏 Acknowledgments 

> Give credit to everyone who inspired your codebase.

I would like to thank...

Original design idea by [Gregoire Vella](https://www.behance.net/gregoirevella). All credits to him.

(back to top)


## ❓ FAQ 

> Add at least 2 questions new developers would ask when they decide to use your project.

- **[Did you use scaffold to generate your models, views and controllers or did you build them from scratch]**

  - [Used a combination of both for different models]

- **[Question_2]**

  - [Answer_2]

(back to top)


## 📝 License 

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

(back to top)