zamcham/PocketCanvas

PocketCanvas

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
  • Key Features
  • 🚀 Presentation
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

PocketCanvas

"PocketCanvas" is a user-friendly web application designed to empower users in managing their personal finances with ease. It offers a comprehensive platform for budget tracking, expense categorization, and gaining valuable insights into spending habits. Whether you're looking to keep a closer eye on your financial goals or simply want to enhance your money management skills, PocketCanvas provides the tools you need.

Want an overview? Watch this video about the app

ERD diagram

The structure of PocketCanvas application is based on the ERD diagram below:

🛠 Built With

Tech Stack

Client

• HTML/CSS

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User Registration and Authentication: Allow users to sign up for accounts and log in securely.
• Create and Delete Transactions: Allow users to add or delete transactions to keep track of money spent
• Add tags and icons: Provide a user-friendly option to categorise the transactions into different tags/categories

(back to top)

🚀 Live Demo

- Live Demo - PocketCanvas Want an overview? Watch this video about the app

(back to top)

💻 Getting Started

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

Prerequisites

Ensure you have Ruby installed on your system. You can check by running the code below in your terminal.

  ruby --version

Setup

Clone or download the Beyond Borders repository to your local machine.

  git clone https://github.com/zamcham/BlogSphere.git

Open your terminal and navigate to the cloned project directory.

Install

This project does not require additional dependencies, just Ruby interpreter. However, it uses RuboCop as a linter and you should set it up as well.

bundle install

Usage

• To run Beyond Borders, run the following command:

  rails s

Open your browser and navigate to:

  http://localhost:3000/

(back to top)

👥 Author

👤 Cristian Zambrano

• GitHub: @zamcham
• LinkedIn: Cristian Zambrano

🔭 Future Features

• Edit a Category Icon
• Customize your profile
• See your current savings, and general balance

(back to top)

🤝 Contributing

Contributions to the User Interface are welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue on the project repository.

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give us a star ⭐️

(back to top)

🙏 Acknowledgments

Thank you to Gregoire Vella, the author of the original design

Special thanks to our team and the Ruby community for their support and contributions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)