• 📗 Table of Contents
• 💲 Budget Trackie
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Installation
    • Database Setup
    • Running the App
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • 💖 Show your support
  • 🙏 Acknowledgments
  • 📝 License

The Budget Trackie 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.

The key features of this project include.

• register and log in, so that the data is private to you.
• Create new categories
• introduce new transactions associated with a category.
• see the money spent on each category.

(back to top)

• Live Demo Link

(back to top)

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

Before you begin, make sure you have the following installed on your machine:

• Ruby: You can download Ruby here.
• Rails: You can install Rails by running the command gem install rails in your terminal.
• A code editor (like VSCode, Sublime, Atom, etc.): You can download VSCode here, Sublime here, and Atom here.
• Git: You can download Git here.
• Node.js: You can download Node.js here.

To setup this project locally:

1. Open terminal in VScode.
2. Navigate to the directory where you want clone the copy of this repository.
3. Create new directory [optional].
4. Clone the repository by running the following command:

git clone [email protected]:MNisarAli/budget_trackie.git

5. Navigate into the cloned repository:

cd budget_trackie

Install the required dependencies by running the following command:

bundle install

To create the database, run the following command:

rails db:create

To migrate the database schema, run the following command:

rails db:migrate

To run the application, run the following command:

rails server

This will start the Rails development server and you can access the application by visiting http://localhost:3000 in your web browser.

(back to top)

The collaborators of this project.

👨‍🚀 M Nisar Ali

• GitHub: @MNisarAli
• Gmail: @[email protected]
• LinkedIn: @Muhammad Nisar Ali

(back to top)

• More conditional checking and features will be added in future
• Implementation of some UX improvements: transitions and/or animations, etc.
• A decent desktop design for the webapp.
• Implementation of left side menu to improve the navigability of the app.

(back to top)

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

Give a ⭐️, if you like this project!, also follow me on GitHub & LinkedIn.

(back to top)

I would like to thank:

• Microverseinc for Readme-template.

Original design idea by Gregoire Vella on Behance in accordance with the Creative Commons license.

(back to top)

This project is MIT licensed.

(back to top)