📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 📷 Video Recording
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Pocolee

Pocolee is a mobile web application that can help you keep track of your daily financial transaction and manage your budget where 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

• View Template Engine ".erb"

Server

• Ruby On Rails

Database

• PostgreSQL

Key Features

• Register a new user: a new user can register by filling out a form with specific information.
• User login: a registered user can log in to the app using his credential.
• Create Category: a user can create a category for his expenses.
• Create transaction: a user can create a transaction that belongs to a specific category.

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

📷 Video Recording

• Video Recoding me explaining the project

(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 Code editor such as VsCode.
• A web browser.
• Postgresql, ruby and ruby on rails should be installed on your local machine

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/arabiu033/budget_app.git

Install

Install this project with:

  cd Budget-app
  gem install

Usage

To run the project, execute the following command:

  rails server

Run tests

To run tests, run the following command:

  rspec spec/

Deployment

You can deploy this project using: Render

(back to top)

👥 Author

👤 Aminu Rabiu

• GitHub: @arabiu033
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Add categories icon: user can choose a category icon from a list of options.
• Add confirmation functionality: newly registered users can receive an email to confirm their registration.
• Sending email for resetting user password

(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 help it stand out by giving it a star ✨

(back to top)

🙏 Acknowledgments

• I would like to thank Microvers for providing this great opportunity and for the project guide as well 👏
• Huge appriciation to Gregoire Vella for providing design system guidelines since this project is built upon that ✨

(back to top)

📝 License

This project is MIT licensed.

(back to top)