Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ghostesso/my-budget-app
The SmartPocket app manages your expenses. You have the ability to make, change, or remove categories and transactions. Each transaction is linked to one or multiple categories. It's built using RoR.
https://github.com/ghostesso/my-budget-app
Last synced: 18 days ago
JSON representation
The SmartPocket app manages your expenses. You have the ability to make, change, or remove categories and transactions. Each transaction is linked to one or multiple categories. It's built using RoR.
- Host: GitHub
- URL: https://github.com/ghostesso/my-budget-app
- Owner: GhostEsso
- License: mit
- Created: 2023-11-19T12:53:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-16T09:41:01.000Z (5 months ago)
- Last Synced: 2024-10-17T06:14:03.061Z (about 1 month ago)
- Language: Ruby
- Homepage: https://moyin-3unn.onrender.com/
- Size: 63.3 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SmartPocket
# 📗 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 **SmartPocket** keeps track of all your expences associated with catogories. It will allow you to:
- 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://moyin-3unn.onrender.com/)
- The Budget App description [Budget App description](https://drive.google.com/file/d/140nRvlsIpRuQ2Yx00-cgSYnrJBtGVvAC/view?usp=sharing)
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 [email protected]:GhostEsso/my-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.
👤 **Essohanam TAMBANA**
- GitHub: [@GhostEsso](https://github.com/GhostEsso)
- Twitter: [@TambanaEssohana](https://twitter.com/TambanaEssohana)
- LinkedIn: [Tambana Essohanam](https://www.linkedin.com/in/essohanam-tambana/)
- [ ] **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.