Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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


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

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

logo

# πŸ“— 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)

# πŸ“– [CashBack]

**CashBack** is a Ruby on Rails mobile web application that allows users to keep track of their expenses and categories. have a list of transactions associated with a category, so that the user can see how much money it spent and on what. [Entity Relationship Diagram](https://github.com/microverseinc/curriculum-rails/blob/main/capstone/images/erd_diagram.png)

## πŸ›  Built With

### Tech Stack

> [Ruby on Rails](https://guides.rubyonrails.org/) (simplify as Rails) is a server-side web application framework written in Ruby under the MIT License. Rails is a model–view–controller (MVC) framework, providing default structures for a database, a web service, and web pages. It encourages and facilitates the use of web standards such as JSON or XML for data transfer and HTML, CSS and JavaScript for user interfacing.

Client

Server

Database

### Key Features

> Key features of the application are

- **Create a category**
- **Add a transaction**
- **Sign up and log in page**

(back to top)

## πŸš€ Live Demo

- [Live Demo](https://www.loom.com/share/c63597a66c6f4f82bc48018c234be8f7)

(back to top)

## πŸ’» Getting Started

> This project can be used by anyone for any good purpose.

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

### Prerequisites

In order to run this project you need:

- Ruby and Rails on you operating system eg. for [Ubuntu 20.04](https://www.digitalocean.com/community/tutorials/how-to-install-ruby-on-rails-with-rbenv-on-ubuntu-20-04)
- [Node.js](https://nodejs.dev/en/) installed
- [PostgreSQL](https://www.postgresql.org/) database installed

### Setup

Clone this repository to your desired folder:

```sh
cd my-folder
git clone https://github.com/DuaneDave/Recipe-app.git
```

### Install

Install this project with:

```sh
cd Recipe-app

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/rails rspec spec
```

### Deployment

You can deploy this project using:

(back to top)

## πŸ‘₯ Authors

πŸ‘€ **Obiebi David**

- GitHub: [@githubhandle](https://github.com/DuaneDave)
- Twitter: [@twitterhandle](https://twitter.com/dave_duane)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-obiebi)

(back to top)

## πŸ”­ Future Features

- Search functionality
- Page pagination

(back to top)

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/DuaneDave/Recipe-app/issues/new).

(back to top)

## ⭐️ Show your support

If you like this project buy the team a [drink](.../.../)

(back to top)

## πŸ™ Acknowledgments

I would like to acknowledge:

- [Microverse](https://www.microverse.org/) for the opportunity to work on this project
- [The creative common](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=) for the design

(back to top)

## ❓ FAQ

- **Is Rails still relevant?**

- [Yes, Rails is still popular among developer](https://blog.railwaymen.org/is-ruby-on-rails-dead)

- **Is it easy to learn Ruby on Rails**

- [It is very easy to learn compared to most of the programming languages](https://careerkarma.com/blog/why-learn-ruby-on-rails/)

(back to top)

## πŸ“ License

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

(back to top)