Budget App

📗 Table of Contents

• 📖 Budget app
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Author
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Budget App

Budget app is 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

Tech Stack

Server

Ruby

Rails

Database

Postgres

Key Features

• User authentication & authorization
• Introduce new transactions associated with a category
• See the total amount of money spent on each category

(back to top)

🚀 Live Demo

Live Demo Link. Watch a live video demo of this project here

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

    ruby >= 3.2.0
    rails >= 7.0
    postgres >- 15.3

Setup

Clone this repository to your desired folder:

  git [email protected]:marvin-nyalik/BudgetApp.git

You need to setup database for these project

  development = budget_app_dev
  test        = budget_app_test
  production  = budget_app_production

or you can use your own database and change the config/database.yml

  default: &default
    adapter: postgresql
    encoding: unicode
    pool: 5
    username: [your_username]
    password: [your_password]
    host: localhost

  development:
    <<: *default
    database: [your_database_for_development]

  test:
    <<: *default
    database: [your_database_for_test]

  production:
    <<: *default
    database: [your_database_for_production]

Install

Install this project with:

  cd BudgetApp
  bundle install

it will install the required gems for running the project

Usage

to use this project:

   rails server -p 3000

it will run the server on localhost:3000

(back to top)

👥 Author

👤 Ikonde (Arnold) Nekemiah

• GitHub: @arnoldnekemiah
• Twitter: @arnoldikonde
• LinkedIn: Ikonde (Arnold) Nekemiah

(back to top)

🔭 Future Features

• Add Web version
• Implement user communities
• Add financial news updates API

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project you can share this project to your friend

(back to top)

🙏 Acknowledgments

• Major appreciations to Gregoire Vella for the Creative Commons design of this project.
• I'd also like to thank Microverse for defining the project requirements

(back to top)

📝 License

This project is MIT licensed.

(back to top)