📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🔭 Acknowledgements
• ❓ FAQ
• 📝 License

🎯 SnapPay

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.

🛠 Built With

Tech Stack

Technology

• Ruby 3.2.2
• Rails 7.0.4.3
• PostgresSQL
• Tailwind CSS

Tools

• VS Code
• GIT
• GITHUB

Key Features

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.

(back to top)

🚀 Live Demo

presentation.mp4

• Live Demo Link
• Presentation video
• Presentation pdf

(back to top)

💻 Getting Started

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.

  git clone git@github.com:shahadat3669/snap-pay.git

Go to the project directory.

  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)

  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.

  EDITOR="code --wait" rails credentials:edit

The scaffolded credentials.yml.enc looks like below:

  postgres_password: Database User Password
  smtp_user_name: SMTP User name
  smtp_password: SMTP User password

To learn more check Custom Credentials documentation.

Add necessary packages

For installing necessary packages, run the following bash command:

  bundle install

Run the server in development mode

In the project directory, you can run the project by using following bash command:

  ./bin/dev

And now you can visit the site with the URL http://localhost:3000

Run the test

For testing you can run:

  bundle exec rspec

(back to top)

👥 Authors

First Author:

Shahadat Hossain

(back to top)

🔭 Future Features

• Live demo will added soon

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

👋 Show your support

Give a ⭐️ if you like this project!

(back to top)

🔭Acknowledgments

• My Family.
• Microverse
• Gregoire Vella for Snapscan - iOs design and branding
• OnlineWebFonts for fonts

(back to top)

❓ FAQ

• Can I use this project for personal use?

  • Yes, you can use it.

(back to top)

📝 License

This project is MIT licensed.

(back to top)