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

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

The Budget app is a convenient application designed to streamline transaction management. It offers categorized lists, along with user-friendly sign-up and login pages. The app empowers users to effortlessly add new categories or transactions, enhancing their control over their financial activities. Built with Ruby on Rails.
https://github.com/iamchristianani/budget-app

postgresql ruby ruby-on-rails

Last synced: 2 months ago
JSON representation

The Budget app is a convenient application designed to streamline transaction management. It offers categorized lists, along with user-friendly sign-up and login pages. The app empowers users to effortlessly add new categories or transactions, enhancing their control over their financial activities. Built with Ruby on Rails.

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Budget App ](#-budget-app-)
- [🛠 Built With ](#-built-with-)
- [🛠 Tech Stack ](#-tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo](#live-demo)
- [🚀 Video Presentation](#presentation)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Authors](#-authors)
- [🔭 Future Feautures](#-future-features)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Budget-app

Bill splitter app is an app for managing expenses which are grouped together based on their types. Users can register and sign up to gain access to the application. Registered users can create new groups, as well as assign expenses and their prices to these groups.

## 🛠 Built With
This app is build with Ruby on Rails and Postgresql.
### Tech Stack
>

  • Ruby

  • >
  • Ruby on Rails

  • >
  • Postgresql
  • ### Key Features

    > - User authentication.
    > - Navigation buttons for moving between pages.
    > - Group creation: Users can create groups with their names and icons.
    > - Expense tracking: Users can create and manage expenses and group them by categories.

    ## 🚀 Live Demo

    - [Live Demo Link](https://bill-splitter-v1fd.onrender.com/)- Powered by Render

    (back to top)

    ## 🚀 Video Presentation

    - [Video Presentation Link](https://www.loom.com/share/76ca96e7229f4800aa389e397c523c7b)- Powered by Loom

    (back to top)

    ## 💻 Getting Started

    ## UML Diagram :

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

    ### Prerequisites

    In order to run this project you need:

    - Mac or PC
    - Install Ruby
    - Install Rails
    - Install Postgresql
    - Understanding of Ruby

    ### Setup

    - Clone this repository to your desired folder:

    ```sh
    git clone https://github.com/iamchristianani/budget-app.git
    ```

    - Navigate into the cloned folder

    ```sh
    cd budget-app

    ```
    ### Install

    - Install this project with:

    ```sh
    bundle install
    ```

    - Set up the database
    Change the username and password of your postgres account in `config/database.yml`

    ```sh
    rails db:create db:migrate
    ```

    - Start the server

    ```sh
    rails s
    ```

    - Run tests

    ```sh
    rails db:migrate RAILS_ENV=test
    ```

    ```sh
    rspec spec
    ```

    - if it shows error try using this command

    ```sh
    bundle exec rspec spec
    ```

    (back to top)

    ## 👥 Author

    👤 **Christian Ani**

    - GitHub: [@iamchristianani](https://github.com/iamchristianani)
    - Twitter: [@kriznode](https://twitter.com/kriznode)
    - LinkedIn: [Christian Ani](https://www.linkedin.com/in/anikriz/)

    (back to top)

    ## 🔭 Future Features

    - [ ] **Implemnt more UX design**
    - [ ] **Create Desktop view**
    - [ ] **Implement the side menu**

    (back to top)

    ## 🤝 Contributing

    Contributions, issues, and feature requests are welcome!

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

    (back to top)

    ## ⭐️ Show your support

    If you like this project, please leave a ⭐️

    (back to top)

    ## 🙏 Acknowledgments
    - Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) in accordance with the [Creative Commons license of the design](https://creativecommons.org/licenses/by-nc/4.0/).

    - I would like to thank Microverse for providing us with reading materials that aided us to during the project development

    (back to top)

    ## 📝 License

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

    (back to top)