https://github.com/devmunyi/budget-tracker
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/devmunyi/budget-tracker
bootstrap5 postgresql 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.
- Host: GitHub
- URL: https://github.com/devmunyi/budget-tracker
- Owner: devMunyi
- License: mit
- Created: 2023-02-13T08:09:43.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-16T16:39:26.000Z (over 3 years ago)
- Last Synced: 2026-01-03T14:39:21.905Z (5 months ago)
- Topics: bootstrap5, postgresql, ruby-on-rails
- Language: Ruby
- Homepage:
- Size: 6.58 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🔭 Project Presentation](#project-presentation)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)
> A 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.
Client
Server
Database
- **[authentication system to allow login and registration]**
- **[list categories of items you spend on]**
- **[list transactions for a specific category]**
### Project Presentation
- [Video](https://www.loom.com/share/2b85199bd38f4a72a190b82c99fd5d52)
### Live Demo
- [BudgetTracker](https://rails-n39a.onrender.com/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need followed installed on your computer:
- Ruby v3+,
- Rails v7+
- PostgreSQL
- An IDE e.g [Visual studio code](https://code.visualstudio.com/).
- [A terminal](https://code.visualstudio.com/docs/terminal/basics).
### Setup
Clone this repository to your desired folder or download the Zip folder:
```
git clone https://github.com/devMunyi/Budget-Tracker
```
- Navigate to the location of the folder in your machine:
**`you@your-Pc-name:~$ cd Budget-Tracker`**
### Install
To install all dependencies, run:
```
bundle install
```
### Database Setup
- Create `.env` file and add the following three lines(be sure to replace with your details):
```
DB_HOST='localhost'
DB_USERNAME='your_postgress_username'
DB_PASSWORD='your_postgress_password'
```
- Then run the following command:
```
rails db:create db:migrate
```
### Usage
To run the project, follow these instructions:
- To get it running on your machine, you may open the project on your IDE and open the terminal
- On the terminal you can run:
```
rails s OR rails server
```
### Run tests
- To run rubcop tests, run the following command:
```
rubocop
```
- To run rspec tests, run the following command:
```
rspec
```
👤 **Samuel Munyi**
- GitHub: [@devMunyi](https://github.com/devMunyi)
- LinkedIn: [Samuel Munyi](https://www.linkedin.com/in/samuel-munyi)
- Twitter: [@munyi_sam](https://twitter.com/munyi_sam)
- [ ] **Implement more methods and features.**
- [ ] **Improve the UI.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
Give a ⭐️ if you like this project and how I managed to build it!
- The original design idea by [Gregoire Vella on Behance](https://www.behance.net/gregoirevella).
- Project from [Microverse](https://bit.ly/MicroverseTN) Ruby on Rails module.
- Thanks to the Microverse team for the great curriculum.
- Thanks to the Code Reviewer(s) for the insightful feedbacks.
- A great thanks to My coding partner(s), morning session team, and standup team for their contributions.
- Hat tip to anyone whose code was used.
- **Can I fork and reuse the repository**
- Yes please, feel free.
- **Can I improve the repository, and my changes will be accepted if they are good?**
- Yes please, nice ideas are welcome, please.
This project is [MIT](./LICENSE) licensed.