Skip to content

makkahwi/cash-hub

Repository files navigation

Currencies Archiving & Sharing Hub (CASH)

Current Version: vX.X.X

Logo

Welcome to the Currencies Archiving & Sharing Hub (CASH), your gateway to organizing and showcasing your currency collection to the world. This open-source project is built to serve collectors while inviting contributions to grow its features and reach.

What is Currencies Archiving & Sharing Hub?

Currencies Archiving & Sharing Hub (CASH) is a user-friendly web app designed for currency collectors who want to organize, document, and share their collections with others. Whether you’re a hobbyist or a professional collector, CASH provides an efficient platform to catalog detailed information about your currencies, including continent, zone, type, value, and more.

The best part? CASH is open-source, so you can contribute to its development, suggest features, or even fork it to create your own customized version.

Features

  • Comprehensive Listings
    Enlist detailed information about your currencies, including type, value, continent, zone, and more.

  • Interactive Showroom
    Public visitors can browse your collection using advanced filtering options.

  • Secured Access
    Admin-only access for data manipulation with Firebase authentication.

  • Open-Source
    Totally transparency and ability for any web developer to contribute and enhance.

  • Modern Tech Stack
    Built with Vue.js 3 and Firebase for an optimized, scalable, and responsive web experience.

Coming Soon Features

  • Enhanced Admin Dashboard
    A feature-rich panel for currency management, detailed reports, and advanced data analysis.

  • Advanced Statistics
    A dedicated dashboard showcasing charts, maps, and key statistics like total counts, collection value, and rare pieces.

  • Market Insights
    Automated total value estimation for your collection based on circulable values.

  • Social Media Integration
    Share your showroom or latest additions on popular platforms.

  • Automatic Photo Integration
    Automatically find and attach appropriate images for each currency piece.

  • Expansion to Other Collections
    Extend the app to support other types of collections, such as stamps or photos.

  • Centralized Currencies Database
    A database for you to identify which currencies are out there to collect. With community-contributed updates.

  • Advanced Features

    • Generate a PDF catalog of your collection.
    • Collection progress tracking with timelines.
    • Localization for administrators and browsers.
  • Centralized Services

    • Support for user registrations and subscriptions.
    • Automated subdomain creation for personal showrooms.
    • SaaS platform for collectors with community-driven updates and premium features.

How to Deploy & Start Using as a Collector

Clone Project Instructions

Demo Live (Developer's Own Showroom)

Developer Notes

ChangeLog

For a full list of changes, see the Changelog.

Technology Stack

  • Frontend: Vue.js 3, Nuxt
  • Backend: Firebase Realtime Database, Firebase Authentication
  • UI Framework: Bootstrap 5
  • Charts and Visualization: ApexCharts
  • Development Tools: Yarn, ESLint, Prettier

Contribution Guidelines

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

To contribute:

  1. Fork the project.
  2. Create your feature branch: git checkout -b feature/YourFeatureName.
  3. Commit your changes: git commit -m 'Add some YourFeatureName'.
  4. Push to the branch: git push origin feature/YourFeatureName.
  5. Open a pull request.

Please ensure your code adheres to the project's guidelines and is well-documented.

How to Start Development

  1. Fork the repository to your GitHub account.
  2. Clone the forked repository to your local machine.
  3. Navigate to the project root directory:
  cd cash-hub
  1. Install dependencies:
  npm i
  1. Start the development server:
  npm run dev
  1. Open your browser and navigate to the development server URL (usually http://localhost:3000) to view the application.
  2. Make changes to the code as needed, and watch for live updates using Vue's Hot Module Replacement (HMR).

How to Report an Issue

We welcome contributions and feedback! To report a bug, suggest a feature, or request support:

  1. Go to the Issues tab of this repository.

  2. Click on New Issue.

  3. Select the appropriate issue template:

    • Bug Report: If you found a bug or error in the app.
    • Feature Request: If you have an idea for a new feature or improvement.
  4. Fill out the form with as much detail as possible.

  5. Submit the issue, and we’ll review it as soon as possible.

Technical Support

If you encounter any issues, have questions, or want to suggest improvements, feel free to:

  1. Open an issue on the GitHub repository.
  2. Reach out to the project maintainer via the contact information provided in the repository.
  3. Join the discussions on the repository to collaborate with other contributors.

We appreciate your feedback and contributions to make the "Currencies Archiving & Sharing Hub" better for everyone!

⭐ Support the Project ⭐

Your support is vital to making Currencies Archiving & Sharing Hub even better! Here’s how you can contribute and help spread the word:

🌟 As a Developer

Dive into the codebase, identify bugs, or build new features. Check out our Developer Notes for more details on how to get started.

⭐ As a GitHub User

Starring our repository is a quick and easy way to show your support and help others discover this project.

👉 Click here to star the repo 👈

GitHub stars

❤️ GitHub Sponsors

Your financial support can accelerate the development of Currencies Archiving & Sharing Hub by covering costs like hosting, integrations, and feature enhancements.

👉 Become a Sponsor 👈

📣 Spread the Word

Help us reach more users and contributors by sharing the project with your network!

Click below to share on your favorite platform:

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Acknowledgements

  • Nuxt.js - The frontend framework that powers this app.
  • Firebase - The backend platform used for data storage and authentication.
  • Bootstrap - The CSS framework for responsive design.
  • All contributors who have helped build and improve this project.

Meet the Developer

This is Suhaib Ahmad, a software developer passionate about leveraging technology to improve health and wellness.

Contact

If you have any questions about the project, feel free to reach out the developer.

Thank you for your interest in "Currencies Archiving & Sharing Hub"! Together, we can make it the go-to solution for collectors worldwide.