Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mnisarali/budget_trackie

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.
https://github.com/mnisarali/budget_trackie

bs-5 capybara devise psql-database rspec ruby-on-rails

Last synced: about 2 months ago
JSON representation

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.

Awesome Lists containing this project

README

        

[![Rails](https://upload.wikimedia.org/wikipedia/commons/thumb/6/62/Ruby_On_Rails_Logo.svg/150px-Ruby_On_Rails_Logo.svg.png "rubyonrails") ](https://rubyonrails.org/)

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [💲 Budget Trackie ](#-budget-trackie-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Installation](#installation)
- [Database Setup](#database-setup)
- [Running the App](#running-the-app)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [💖 Show your support ](#-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 💲 Budget Trackie

**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.

## 🛠 Built With

### Tech Stack

Server

Database

### Key Features

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

- [Live Demo Link](https://budgettrackie.onrender.com)

(back to top)

## 💻 Getting Started

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

### Prerequisites

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

- [x] Ruby: You can download Ruby [here](https://www.ruby-lang.org/en/downloads/).
- [x] Rails: You can install Rails by running the command `gem install rails` in your terminal.
- [x] A code editor (like VSCode, Sublime, Atom, etc.): You can download VSCode [here](https://code.visualstudio.com/download), Sublime [here](https://www.sublimetext.com/3), and Atom [here](https://atom.io/).
- [x] Git: You can download Git [here](https://git-scm.com/downloads).
- [x] Node.js: You can download Node.js [here](https://nodejs.org/en/download/).

### Setup

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
```

### Installation

Install the required dependencies by running the following command:

```
bundle install
```

### Database Setup

To create the database, run the following command:

```
rails db:create
```

To migrate the database schema, run the following command:

```
rails db:migrate
```

### Running the App

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)

## 👥 Authors

The collaborators of this project.

👨‍🚀 **M Nisar Ali**

- GitHub: [@MNisarAli](https://github.com/MNisarAli)
- Gmail: [@[email protected]](mailto:[email protected])
- LinkedIn: [@Muhammad Nisar Ali](https://www.linkedin.com/in/muhammad-nisar-ali)

(back to top)

## 🔭 Future Features

- [ ] **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)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## 💖 Show your support

Give a ⭐️, if you like this project!, also follow me on [GitHub](https://github.com/MNisarAli) & [LinkedIn](https://www.linkedin.com/in/muhammad-nisar-ali).

(back to top)

## 🙏 Acknowledgments

I would like to thank:
- [Microverseinc](https://github.com/microverseinc) for [Readme-template](https://github.com/microverseinc/readme-template).

Original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella) in accordance with the [Creative Commons license](https://creativecommons.org/licenses/by-nc/4.0/).

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

(back to top)