PENNY WISE

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors

• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 PennyWise

Penny Wise is 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.

🛠 Built With

Tech Stack

Server

• Ruby

Database

• PostgreSQL

Key Features

• This Ruby on Rails application allows the user to:
  • register and log in, so that the data is private to them.
  • introduce new transactions associated with a category.
  • see the money spent on each category.

(back to top)

🚀 Live Demo

Penny-Wise Penny-Wise Video Demo

UML Diagram

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• To install ruby on your PC. You can read this documentation on how to do so
• To install postgresql on your PC. You can read this documentation on how to do so
• Know how to navigate directories or folders at the CLI.
• Know how to get the URL(https/ssh) of a repository on GitHub.
• You should have a code editor installed, preferably VSCode
• In order to run this project you need:

Setup

In desired folder or directory in the CLI, run the command:

git clone git@github.com:elarhadu/Penny-Wise.git

Navigate into the cloned folder or repository by running the command:

cd Penny-Wise

If VsCode is your default code editor, run:

code .

You are all set up!

Install

Install this project with:

 bundle install

Usage

To setup the database, run

rails db:drop db:create db:migrate

To run the project, execute the following command:

ruby bin/rails server

Run tests

To run tests, run the following command:

  rspec spec spec/[filename.rb]

(back to top)

👥 Author

👤 Emmanuella Adu

• GitHub: @elarhadu
• Twitter: @elarh_
• LinkedIn: Emmanuella Adu

(back to top)

🔭 Future Features

• User profiles - allow users to create a profile page where they can add a profile picture, bio, and other information about themselves.
• User authentication via social media accounts - allow users to sign up and log in to your app using their social media accounts such as Facebook, Twitter, or Google.
• User roles - allow administrators to assign different roles to users, such as moderators, editors, or contributors. This can be useful for managing access and permissions within your app.
• Search functionality - implement a search feature that allows users to search for specific groups, categories, or posts.
• Notifications - add notifications for users to receive updates on new posts, comments, or activity related to their groups or categories.
• Rating system - implement a rating system where users can rate posts, comments, or groups, and display the average rating for each.
• User messaging - allow users to send private messages to each other within Penny-Wise.
• Multi-language support - add support for multiple languages to make Penny-Wise accessible to users from different countries.
• Analytics - track user activity and engagement within your app using analytics tools, such as Google Analytics, to gain insights into how users interact with Penny-Wise.

(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 us a ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this project inspiration and Gregoire Vella for UI for this project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)