emmiiorji/budget-app

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.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 📍 Database ERD
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements

• 📝 License

📖 Budget App

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

Client

• Ruby on Rails

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Sign up and log in
• Manage a category
• Manage transaction belonging to a category

(back to top)

🚀 Live Demo

• Live Demo Link
• Video Demo

(back to top)

📍 Database Entity Relationship Diagram

• Link to the Database ERD

(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:

• A command line interface
• Install Ruby
• Install PostgreSQL database
• Have Rails set up and running (gem install rails)

Setup

• Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:emmiiorji/budget-app.git

• Create a .env file in the root directory with your database configuration details following the .env.example file as guide
• Create an account at cloudinary and include the api keys within the .env file

Install

Install this project with:

  cd my_blog
  bundle install

Usage

To run the project, execute the following command:

  rails db:migrate
  rails server

Run tests

To run tests, run the following command:

  rspec

(back to top)

👥 Author

👤 Emmanuel Orji-Ihuoma

• GitHub: @emmiiorji
• Twitter: @emmiiorji
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Allow transaction to have more than one category
• Improve user interface

(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, please give a ⭐️!

(back to top)

🙏 Acknowledgments

Shout out to Gregoire Vella on Behance for the original design idea.

(back to top)

(back to top)

📝 License

This project is MIT licensed.

(back to top)