budget-app

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

The Budget App is a mobile web application that enables groups to manage budgets by providing a list of transactions categorized by expenses. This feature helps to track spending and understands where money is being spent. Built with HTML, CSS, JavaScript, and Ruby.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<!--
HOW TO USE:
This is an example of how you may give instructions on setting up your project locally.

Modify this file to match your project and remove sections that don't apply.

REQUIRED SECTIONS:
- Table of Contents
- About the Project
  - Built With
  - Live Demo
- Getting Started
- Authors
- Future Features
- Contributing
- Show your support
- Acknowledgements
- License

After you're finished please remove all the comments and instructions!
-->

<h3><b>Budget-App</b></h3>

</div>

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Budget App ](#-budget-app-)
  - [🛠 Built With ](#-built-with-)
    - [Ruby on Rails ](#ruby-on-rails-)
    - [Key Features ](#key-features-)
  - [🚀 Live Demo ](#-live-demo-)
  - [💻 Getting Started ](#-getting-started-)
    - [Prerequisites](#prerequisites)
    - [Setup](#setup)
    - [Usage](#usage)
    - [Run tests](#run-tests)
  - [👥 Authors ](#-authors-)
  - [🔭 Future Features ](#-future-features-)
  - [🤝 Contributing ](#-contributing-)
  - [⭐️ Show your support ](#️-show-your-support-)
  - [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Budget App <a name="about-project"></a>

**The Budget app** is a mobile web application that enable users as groups manage their budgets: where expense lists are created and managed as transactions associated with a group, to enable proper accountability of financial disposement and outflow.

## 🛠 Built With <a name="built-with"></a>

### Ruby on Rails <a name="tech-stack"></a>

<details>
  <summary>Client</summary>
  <ul>
    <li><a href="https://reactjs.org/">React.js</a></li>
  </ul>
</details>

<details>
  <summary>Server</summary>
  <ul>
    <li><a href="https://www.ruby-lang.org/en/">Ruby</a></li>
  </ul>
</details>

<details>
<summary>Database</summary>
  <ul>
    <li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
  </ul>
</details>

### Key Features <a name="key-features"></a>

- **Spash Screen**
- **Sign up and log in pages**
- **Home page (Groups page)**
- **Transactions page**
- **"Add a new group" page**
- **"Add a new transaction" page**
- **Unit & Integration Testing with RSpec & Capybara**
- **Aunthentication with Devise**
- **Database management with Postgres**
- **ORM with ActiveRecord**
- **Deployment with Render**
- **Project Demo with Loom**

## 🚀 Live Demo <a name="live-demo"></a>

> View Video Record [here](https://www.loom.com/share/61869fc05a214954a763c78bb6f4838e)

> View Live Demo [here](https://budget-app-s6rh.onrender.com)

## 💻 Getting Started <a name="getting-started"></a>

### Prerequisites

In order to run this project you need:

Ruby installed
Postgresql installed

gem install rails

### Setup

Clone this repository to your desired folder:

git clone https://github.com/dialite/budget-app.git

cd budget-app

### Usage

To run the project, execute the following command:

rails server

### Run tests

To run tests, run the following command:

rspec

## 👥 Authors <a name="authors"></a>

👤 **raymond olisa**

- GitHub: [@dialite](https://github.com/dialite)
- LinkedIn: [Raymond Olisa](https://www.linkedin.com/in/raymond-olisa-775929243/)

## 🔭 Future Features <a name="future-features"></a>

- Geographical locations of transactions carried out
- Heirarchy of expense preference

- [ ] **Add API Endpoints**

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/dialite/budget-app.git/issues).

## ⭐️ Show your support <a name="support"></a>

If you like this project, please add a ⭐️

## 🙏 Acknowledgments <a name="acknowledgements"></a>

Credit to Microverse for the project specification

Credit to [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) for the design guidelines.

budget-app

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README