Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shahadat3669/snap-pay
The SnapPay is a Microverse Ruby on Rails capstone project which is about building 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. SnapPay is designed with a sleek and user-friendly interface.
https://github.com/shahadat3669/snap-pay
bootstrap5 capstone-project microverse mobile-ui ruby-on-rails tdd
Last synced: about 6 hours ago
JSON representation
The SnapPay is a Microverse Ruby on Rails capstone project which is about building 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. SnapPay is designed with a sleek and user-friendly interface.
- Host: GitHub
- URL: https://github.com/shahadat3669/snap-pay
- Owner: shahadat3669
- License: mit
- Created: 2023-04-23T10:06:23.000Z (almost 2 years ago)
- Default Branch: dev
- Last Pushed: 2023-04-30T14:08:36.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T12:29:16.751Z (4 months ago)
- Topics: bootstrap5, capstone-project, microverse, mobile-ui, ruby-on-rails, tdd
- Language: Ruby
- Homepage: https://snap-pay.onrender.com/
- Size: 9.53 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- 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)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🔭 Acknowledgements](#acknowledgements)
- [❓ FAQ](#faq)
- [📝 License](#license)
The SnapPay, a Microverse Ruby on Rails capstone TDD project allows you to easily track your expenses by creating a list of transactions and categorizing them. By doing so, you can effortlessly analyze your spending patterns and gain valuable insights into where your money is going. SnapPay is designed with a sleek and user-friendly interface that can be accessed from your mobile device, making it a convenient tool for anyone looking to take control of their finances.
Technology
- Ruby 3.2.2
- Rails 7.0.4.3
- PostgresSQL
- Tailwind CSS
Tools
- VS Code
- GIT
- GITHUB
Main functionalities which the app will have:
- Splash screen with links to sign up and log in pages
- Sign up page where users can register with their full name, email, and password
- Log in page where users can sign in using their email and password
- Home page (categories page) displaying a list of categories with their name, icon, and total amount of transactions
- Transactions page displaying a list of transactions ordered by most recent, with the total amount for the category at the top
- Option to add a new transaction for the selected category
- "Add a new category" page with a form for creating a new category, including name and icon fields
- "Add a new transaction" page with a form for creating a new transaction, including name, amount, and categories fields.
## 🚀 Live Demo
https://user-images.githubusercontent.com/55840999/235326674-2f3843be-b0df-40bb-a9bf-d3fbb254df25.mp4
- [Live Demo Link](https://snap-pay.onrender.com)
- [Presentation video](https://drive.google.com/file/d/1bJaj2GTkXzuOpU93F1yjW8HnDHlBq_a1/view?usp=sharing)
- [Presentation pdf](presentation.pdf)
To get a local copy up and running follow these simple example steps.
### Prerequisites
you have to those tools in your local machine.
- [ ] Ruby (3.2.0)
- [ ] Rails (7.0.4)
- [ ] PostgresSQL
- [ ] GIT & GITHUB
- [ ] Any Code Editor (VS Code, Brackets, etc)
### Clone Repo
Clone the project using the following bash command in an appropriate location.
```bash
git clone [email protected]:shahadat3669/snap-pay.git
```
Go to the project directory.
```bash
cd snap-pay
```
### Adding credentials
Rails stores secrets in `config/credentials.yml.enc`, which is encrypted and hence cannot be edited directly. Rails uses `config/master.key`. If you have the master key, to add or change credentials in your terminal, run this command (change the name of you editor if you need for example code for VS Code)
```bash
EDITOR="code" rails credentials:edit
```
This command will create the credentials file if it does not exist. Additionally, this command will create config/master.key if no master key is defined.
Here pass the --wait flag to make sure the encryption happens after the edits have been saved and the editor closed.
```bash
EDITOR="code --wait" rails credentials:edit
```
The scaffolded credentials.yml.enc looks like below:
```bash
postgres_password: Database User Password
smtp_user_name: SMTP User name
smtp_password: SMTP User password
```
To learn more [check Custom Credentials](https://edgeguides.rubyonrails.org/security.html#custom-credentials) documentation.
### Add necessary packages
For installing necessary packages, run the following bash command:
```bash
bundle install
```
### Run the server in development mode
In the project directory, you can run the project by using following bash command:
```bash
./bin/dev
```
And now you can visit the site with the URL http://localhost:3000
### Run the test
For testing you can run:
```bash
bundle exec rspec
```
### First Author:
**Shahadat Hossain**
[](https://github.com/shahadat3669) [](www.linkedin.com/in/shahadat3669) [](https://twitter.com/shahadat3669)
- [ ] **Live demo will added soon**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../../issues/).
Give a ⭐️ if you like this project!
- My Family.
- [Microverse](microverse.org)
- [Gregoire Vella](https://www.behance.net/gregoirevella) for [Snapscan - iOs design and branding](https://www.behance.net/gallery/19759151/Snapscan-iOs-design-and-branding)
- [OnlineWebFonts](http://www.onlinewebfonts.com) for fonts
- **Can I use this project for personal use?**
- Yes, you can use it.
This project is [MIT](./LICENSE) licensed.