prangonghose / transactiontrove

This is a budget storing app built with Rails framework to let users sign up, login, and add different categories to keep a track of their expenses and transaction. They can add transactions for different categories and have a look at their total spending. This app is useful when someone must keep track of their budget.

Transaction Trove

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Key Features
    • Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 🖥 User Interface
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Project Name

Transaction Trove using Rails

About this project

This is a budget storing app built with Rails framework to let users sign up, login, and add different categories to keep a track of their expenses and transaction. They can add transactions for different categories and have a look at their total spending. This app is useful when someone must keep track of their budget.

🛠 Built With

• Ruby, Ruby on Rails, JavaScript, HTML, CSS

Key Features

Key features of the application.

• A full stack app where users can add their expenses and keep a track of their budget.
• Users can add categories of expenses and add transactions.
• Users will be able to authenticate their accounts.
• Users data is private to every user and none can access each others data.

(back to top)

🚀 Live Demo

Live demo is currently not available due to restriction on free accounts of Render. Take a look at the UI of the website below.
Presentation of the project is available here.

💻 Getting Started

To clone the repository in local environment try following steps.

Prerequisites

• A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Ruby and gem for package installation.

$ ruby --version && gem --version

Note: This project is built with Ruby version 3.1.3

Setup

Clone the repository using this link.

Install

In the terminal, go to your file directory and run this command.

$ git clone https://github.com/PrangonGhose/TransactionTrove

Get into development

In the terminal, run these commands to get into development.

$ cd Rails-recipe

$ bundle init

$ bundle install (install dependencies)

Note: You might need to update database.yml for development and testing environments with necessary username and password for your database in their respective positions. Because of free deployment, sending of user confirmation email option can take several hours to reach to the user mail box.

$ rails db:create

$ rails db:migrate

$ rails server

Usage

This website is applicable for both mobile and desktop version.

Run Test

$ rspec

(back to top)

User Interface

Index Page

Categories Page	Transactions Page

Add Category Page	Add Transaction Page

(back to top)

👥 Authors

👤 Prangon Ghose

• GitHub: @PrangonGhose
• LinkedIn: Prangon Ghose

(back to top)

🔭 Future Features

• Add animation to splash screen
• Enable users to delete categories and transactions
• Develop side menu for interacting with the website

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

Authors would like to thank:

• Gregoire Vella
• Microverse
• Code Reviewers
• Coding Partners

(back to top)

📝 License

This project is MIT licensed.

transactiontrove's Issues

Security issue

As a suggestion, it is a good practice to hide your e-mail and your key in order to avoid other people stealing them:
instead :
config.action_mailer.smtp_settings = {
address: 'smtp-relay.sendinblue.com',
port: 587,
user_name: '[email protected]',
password: 'U8gdwSB4PFh7G3DY',
authentication: 'login',
enable_starttls_auto: true
}

Use the environment variables:

config.action_mailer.smtp_settings = {
address: 'smtp-relay.sendinblue.com',
port: 587,
user_name: ENV["SENDINBLUE_EMAIL"],
password: ENV["SENDINBLUE_PASSWORD"],
authentication: 'login',
enable_starttls_auto: true

}