https://github.com/yusufyusie/budget-app
The SpendSmart app keeps track of all your expences. You can create, edit, delete categories and transactions. Each transaction is associeated with 1 or many categories. Built with RoR.
https://github.com/yusufyusie/budget-app
devise postgresql ruby-on-rails testing
Last synced: about 2 months ago
JSON representation
The SpendSmart app keeps track of all your expences. You can create, edit, delete categories and transactions. Each transaction is associeated with 1 or many categories. Built with RoR.
- Host: GitHub
- URL: https://github.com/yusufyusie/budget-app
- Owner: yusufyusie
- License: mit
- Created: 2024-02-07T21:25:40.000Z (over 2 years ago)
- Default Branch: dev
- Last Pushed: 2024-02-13T03:16:44.000Z (over 2 years ago)
- Last Synced: 2025-01-15T14:12:12.433Z (over 1 year ago)
- Topics: devise, postgresql, ruby-on-rails, testing
- Language: Ruby
- Homepage:
- Size: 2.96 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SpendSmart
# 📗 Table of Contents
- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [💻 Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [📝 License](#license)
The **SpendSmart** keeps track of all your expences associated with catogories. It will allow you to:
- This name emphasizes the action of spending money wisely
- create new transactions in order keep track of your expences
- update/delete existing transactions
- create new categories in order to classify your expences by categories
- see the calculated total amount of expences per category
- update/delete existing categories
Client
Server
Database
- **create/update/delete categories of transactions (expences)**
- **create/update/delete transactions (expences) associated with a category**
- **calculate total amount of expences for each category**
- The Live Demo is available [here](https://budget-app-pkds.onrender.com/)
- The Live vedio is available [here](https://www.loom.com/share/6aaf065b886b417a9cdf7e59d841e766?sid=bd3ccbee-cbad-4409-8996-9a9cee47a511/)
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- GitHub account;
- Git installed on your OS;
- VSCode (or another code editor);
- modern browser (supporting HTML5 and CSS3) is highly recommended;
- [Ruby](https://www.ruby-lang.org/en/documentation/installation/) installed;
- [Ruby on Rails](https://gorails.com/guides) installed;
- [Node.js and npm](https://nodejs.org/) installed.
### Setup
Clone this repository to your desired folder:
Login to your GitHub account. Clone this repository to your desired folder:
> cd my-folder
> git clone git@github.com:yusufyusie/budget-app.git
Setup database:
> sudo -u postgres createuser --interactive --pwprompt
(provide the username and password described in [config/database.yml](./config/database.yml))
### Install
Install the dependencies:
> gem install
> npm install
Create database:
> bin/rails db:create
(OPTIONAL) Fill the database with sample records:
> bin/rails db:seed
### Usage
To run the server:
> rails server
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
### Run tests
To run tests, run the following command:
> rspec
You can also check linter errors by running these commands:
> rubocop
> npx stylelint "**/*.{css,scss}"
(OPTIONAL) For testing the confirmation emails:
> gem install mailcatcher
Open [http://localhost:1080](http://localhost:1080) to view it in your browser.
👤 **Yesuf Fenta**
- GitHub: [@yusufyusie](https://github.com/yusufyusie)
- LinkedIn: [in/yusufyusie](https://www.linkedin.com/in/yusufyusie)
- Twitter: [@yusufyusie](https://twitter.com/yusufyusiee)
- [ ] **add transactions/animations**
- [ ] **add styles for desktop version**
- [ ] **improve UX/UI design**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
If you like this project just star it!
Original design idea by Gregoire Vella
I would like to thank the Microverse program for the knowledge and skills I have acquired in Modules 1-5.
I am grateful to all previous project reviewers for their advice. Thanks to them I could build this app.
This project is [MIT](./LICENSE) licensed.