Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Budget App 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/ijeomaodinko/budget-app

devices devise rails7 rspec ruby rubyonrails

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/ijeomaodinko/budget-app
Owner: ijeomaodinko
Created: 2022-11-21T19:38:26.000Z (almost 2 years ago)
Default Branch: develop
Last Pushed: 2023-09-13T09:21:16.000Z (about 1 year ago)
Last Synced: 2024-09-26T00:19:43.786Z (8 days ago)
Topics: devices, devise, rails7, rspec, ruby, rubyonrails
Language: Ruby
Homepage:
Size: 3.31 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        



  

  


 









# 📗 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)

  - [Run tests](#run-tests)

  - [Install](#install)

  - [Usage](#usage)

  - [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 🌍

**Budget App** 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 

- Major languages: Ruby

- Frameworks: Ruby on Rails, Capybara

- Library: CanCanCan

- Technologies used: Rubocop, Gem, Postgresql

- Code Editor: Visual Studio

- Testing: Rspec

### Tech Stack 

  Client

  


    React.js

  


  Server

  


    RubyonRails

  


Database

  


    PostgreSQL

  


### Key Features 

- **Authorization of users**

- **Adding of categories and expenses**

- **Authentication of users**



  



(back to top)


## 🚀 Live Demo 

- [Live Demo Link](https://sheltered-shore-56941.herokuapp.com/)

(back to top)


## 💻 Getting Started 

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

Open your console. Run the following 

If you are using HTTPS

    "git clone https://github.com/ijeomaodinko/Budget-app.git

If you are using a SSH key.

    "git clone https://github.com/ijeomaodinko/Budget-app.git

Press ENTER to create your local clone. After creating it, you can open the app through the open folder in Vscode or typing   `cd blog-app`    on the terminal 

### Prerequisites

In order to run this project you need:

- A modern web browser like Chrome, Safari, Firefox, etc.

- JavaScript enabled.

- Ruby on rails

- Postgres

### Setup

Clone this repository to your desired folder:

    cd my-folder

    git clone https://github.com/ijeomaodinko/Budget-app.git

    bundle install

### Build the Development Server

    rails s 

Open it by accessing http://localhost:3000/ on your browser.

### To Run Test

To install rspec in the terminal:

    $ gem install rspec

To run tests, run this command

    $ rspec ./spec/#{filename}_spec.rb

    

### Create, Drop and, Reset a Database

    rails db:create

    rails db:drop

    rails db:reset

### Generate Schema

    rails db:migrate

### Generate Controller

    rails generate controller NAME [action action] [options]

    

### Deployment

You can deploy this project using: Heroku

(back to top)


##  👤 Author  🖊📖

  **Ijeoma Odinko**

- GitHub: @ijeomaodinko

- Twitter: @Iodinko

- LinkedIn: ijeomaodinko

(back to top)


## 🔭 Future Features 

- [ ] **Add a feature that tells when expense exceed amount possess**

(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 

Give a ⭐️ if you like this project...

(back to top)


## 🙏 Acknowledgments 

 I appropriate credit to Gregoire Vella on Behance the author of the original design, as required by the Creative Commons license of the design

(back to top)


## ❓ FAQ 

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

- **How to create expenses for a category**

  - If you are done creating category,you can move ahead and create expense through clicking on the 

  button ``Add Expense``.

- **How to Sign Up**

  - On visiting the site, the main page has two buttons where you can login or sign up.

(back to top)


## 📝 License 

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

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)