Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wahaj-ali/every-penny
This project is created as part of the rails capstone at Microverse. This app is a mobile web application where a user manage its budget: have a list of transactions associated with a category, so that the user can see how much money it spent and on what.
https://github.com/wahaj-ali/every-penny
backend postgresql ruby rubyonrails
Last synced: 30 days ago
JSON representation
This project is created as part of the rails capstone at Microverse. This app is a mobile web application where a user manage its budget: have a list of transactions associated with a category, so that the user can see how much money it spent and on what.
- Host: GitHub
- URL: https://github.com/wahaj-ali/every-penny
- Owner: Wahaj-Ali
- License: mit
- Created: 2023-04-24T11:42:17.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2023-04-27T14:59:41.000Z (over 1 year ago)
- Last Synced: 2024-10-16T15:00:12.501Z (about 1 month ago)
- Topics: backend, postgresql, ruby, rubyonrails
- Language: Ruby
- Homepage: https://budget-app-eydq.onrender.com/
- Size: 629 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 📗 Table of Contents
- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Every Penny\] ](#-every-penny-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Live Demo ](#-live-demo-)
- [🚀 Video Project Presentation ](#-video-project-presentation-)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Database creation](#database-creation)
- [Usage](#usage)
- [Run tests](#run-tests)
- [or :](#or-)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)
**This project is created as part of the rails capstone at Microverse. This app is a mobile web application where a user manage its budget: have a list of transactions associated with a category, so that the user can see how much money it spent and on what.**
- View Recipes for the logged in user
- logged in user can delete their recipes
- Logge in user can add new recipes
- Logged in user can make the recipe public or private
- Public recipes can be viewd by any user
Server
Database
- **Add new categories**
- **Delete categories**
- **Add new transactions for each category**
- **Authentication using Devise gem**
- **Authorization using Cancancan gem**
- **Splash screen showing the name of the App and options to log in/sign up**
## 🚀 Video Project Presentation
- -Video Project Presentation Link
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
> You need the following tools be installed in your computer:
> - [Rails](https://guides.rubyonrails.org/)
> - [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)
> - [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)
> - IDE
> - PostgreSQL
### Setup
Clone this repository to your desired folder:
```sh
cd my-prefered-folder
git clone https://github.com/Wahaj-Ali/every-penny.git
```
### Install
Install this project with:
```sh
cd every-penny
bundle install
```
### Database creation
Next, use this command to create the databases:
```
rails db:create
rails db:migrate
```
### Usage
To run the project, execute the following command:
```sh
rails server or rails s
```
### Run tests
To run tests, run the following command:
before you run the tests
```
rails db:seed RAILS_ENV=test
```
```sh
rspec spec/
```
### or :
```
rspec spec/models
rspec spec/views
```
👤 **Wahaj Ali**
- GitHub: [@Wahaj-Ali](https://github.com/Wahaj-Ali)
- LinkedIn: [@wahaj-ali96](https://www.linkedin.com/in/wahaj-ali96/)
- [ ] **Sidebar menu for the mobile version**
- [ ] **Some UX improvements: include transitions and/or animations, etc.**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](https://github.com/Wahaj-Ali/every-penny/issues).
If you like this project please give a⭐️ and share with your friends.
- Thanks to the Microverse team for the great curriculum.
- Hat tip to anyone whose code was used
- I would like to thank "Gregoire Vella" for the [Amazing Design Template](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding?tracking_source=).
This project is [MIT](https://github.com/Wahaj-Ali/every-penny/blob/dev/LICENSE) licensed.