federicaulzurrun/PennyLane

PennyLane is a web application designed to help users track and manage their financial transactions seamlessly.

PENNYLANE

📗 Table of Contents

• 📗 Table of Contents
• 📖 School Library
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 PennyLane

PennyLane is a web application designed to help users track and manage their financial transactions seamlessly. Whether it's monitoring your personal expenses or keeping a record of shared expenses within groups, PennyLane offers an intuitive and efficient platform to stay on top of your finances.

🛠 Built With

Tech Stack

Back-End

• Ruby
• Ruby on Rails

Database

• PostgreSLQ

Front-End

• HTML/CSS
• JavaScript
• Font Awesome

Key Features

• User Authentication: PennyLane provides secure user authentication and registration processes, ensuring your financial data remains private.

• Expense Tracking: Easily record and categorize your transactions to maintain a clear overview of your spending habits.

• User-Friendly Interface: PennyLane's clean and intuitive interface ensures a smooth user experience, making financial management a breeze.

(back to top)

🚀 Live Demo & preview

walkthrough loom live demo

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Make sure you have Ruby and Ruby on Rails installed on your computer before running the project. To check if you have Ruby installed, open your console and run the command ruby -v.

If Ruby is not installed, follow the instructions below based on your operating system:

Windows Follow the tutorial for installing Ruby on Windows.

MacOS Run the following commands to install Ruby using Homebrew:

  brew install rbenv ruby-build
  echo 'if which rbenv > /dev/null; then eval "$(rbenv init -)"; fi' >> ~/.bash_profile
  source ~/.bash_profile

  # Install Ruby
  rbenv install 3.0.1
  rbenv global 3.0.1
  ruby -v

To install Ruby on Rails, run:

  gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/federicaulzurrun/PennyLane.git

Install

Install this project with:

  bundle install 

Usage

  rails s

Run tests

To run tests, run the following command:

  rspec spec

Deployment

To deploy the project locally, run the following command:

  rails s

👥 Authors

👤 Federica Ulzurrun

• GitHub: @federicaulzurrun
• Twitter: @ulzurrunfede
• LinkedIn: Federica Ulzurrun

(back to top)

🔭 Future Features

• [Group Expense Sharing] Collaborate with friends, family, or colleagues by creating shared expense groups. PennyLane calculates and splits expenses, simplifying the process of settling accounts
• [Aggregated Spending] Get insights into your financial behavior with the "Aggregate Spending" feature, showcasing your total expenditures.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give it a start!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for allowing me to make this project. I would also like to acknowledge Gregoire Vella, how is the creator of the desing use for PennyLane application.

(back to top)

📝 License

This project is MIT licensed.

(back to top)