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

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

This expense management app, developed using Ruby on Rails, enables users to create new categories and record expenses within each category. As a result, you can easily generate a list of transactions associated with each category.
https://github.com/ginabeki/budget-app

Last synced: 25 days ago
JSON representation

This expense management app, developed using Ruby on Rails, enables users to create new categories and record expenses within each category. As a result, you can easily generate a list of transactions associated with each category.

Awesome Lists containing this project

README

        

# πŸ“— Table of Contents

- [πŸ“— Table of Contents](#-table-of-contents)
- [πŸ“– ExpenseApp ](#-expenseapp-)
- [πŸ›  Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [πŸš€ Live Demo ](#-live-demo-)
- [Preview](#preview)
- [πŸ’» Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [πŸ‘₯ Author ](#-author-)
- [πŸ”­ Future Features ](#-future-features-)
- [🀝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [πŸ™ Acknowledgments ](#-acknowledgments-)
- [πŸ“ License ](#-license-)

- [🀝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [πŸ™ Acknowledgements](#acknowledgements)

- [πŸ“ License](#license)

# πŸ“– ExpenseApp

Expense App is an expenses management app created using Ruby on Rails. It allows a user to create new categories and create new expenses for each category thus you have a list of transactions associated with a category.

## πŸ›  Built With

### Tech Stack

### Key Features

- User Registration.
- User login.
- Create Category: a user can create a category for his expenses.
- Create transaction(expense): a user can create a transaction that belongs to a specific category.

## Preview

![Mobile Design](./mobile.png)

## πŸ’» Getting Started

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

### Prerequisites

In order to run this project you need:

- IDE or code editor: **VsCode, atom, sublime**...
- To have [Ruby](https://www.ruby-lang.org/en/) and [Git](https://git-scm.com/) installed on your system.
- To have [Node.js](https://nodejs.org/) installed on your system.

After installing Ruby, run the following command to install rails.-

```sh
gem install rails
```

### Setup

Clone this project on your local machine using the following command in your terminal:

```sh
git clone https://github.com/ginabeki/Budget-app.git
```

### Install

Run the following command to install all project's dependencies:

```sh
cd Budget-app
bundle install
node install
```

### Usage

To run the project, execute the following command:

Example command:

```sh
rails server
```

OR

```sh
rails s
```

### Run tests

To run tests, run the following command:

Example command:

```sh
gem install rails rspec
rspec ./spec/models/
```

## πŸ‘₯ Author

πŸ‘€ **Gina Beki**

- GitHub: [@ginabeki](https://github.com/ginabeki)
- Twitter: [@gina](https://twitter.com/ginabeki)
- LinkedIn: [@ginabeki](https://www.linkedin.com/in/ginabeki/)

## πŸ”­ Future Features

- **Deploy the project and make it available for every one.**
- **Advance the UI**

## 🀝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/ginabeki/Budget-app/issues).

## ⭐️ Show your support

If you like this project, kindly give it a star ⭐️

## πŸ™ Acknowledgments

- MicroverseπŸ˜‰
- Ruby on Rails DocumentationπŸ™ƒ
- Huge appreciation to [Gregoire Vella](https://www.behance.net/gregoirevella) for providing design system guidelinesπŸ™ƒ

## πŸ“ License

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

(back to top)