📗 Table of Contents

• 📖 About the Project

  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo

• 💻 Getting Started

  • Setup
  • Prerequisites
  • Usage

• 👥 Author

• 🔭 Future Features

• 🤝 Contributing

• ⭐️ Show your support

• 🙏 Acknowledgements

• 📝 License

📖 Budgget

Budgget is a budgeting app that allows you to keep track of your expenses and income. You can create your own categories and associate them with your transactions.

🛠 Built With

Tech Stack

• Ruby
• Rails
• PostgreSQL

Key Features

• Create an account.
• Create categories.
• Create transactions.

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

Prerequisites

To run this project you need the following dependencies:

• Ruby
• Rails
• PostgreSQL

Setup

• Clone this repository to your local machine:

  git clone [email protected]:shasherazi/budget-app.git
  cd budget-app

• Install dependencies:

  bundle install

• Create environment variables POSTGRESQL_USER and POSTGRESQL_PASSWORD or edit config/database.yml with your database connection info.

• Recreate Data Base:

  rake db:schema:load

Usage

To run the project, execute the following command in the terminal:

  cd buddget
  ./bin/dev

👥 Author

👤 Syed Hassan Askri

• GitHub: shasherazi
• Twitter: shasherazi
• LinkedIn: shasherazi

(back to top)

🔭 Future Features

• Add picture to user account.
• Generate reports.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse community for their support and guidance.

Special thanks for Gregoire Vella by providing the orignal design idea.

(back to top)

📝 License

This project is MIT licensed.

(back to top)