Skip to content

README.md

Latest commit

 

History

History
131 lines (104 loc) · 5.26 KB

README.md

File metadata and controls

131 lines (104 loc) · 5.26 KB

🎫 VissiPass

Your Easy Path to a Civilized Visitor Management Experience!

React Appwrite License

Docs Issues Forks Stars Last Commit

VissiPass is a digital pass generation system tailored for seamless and secure visitor management in organizations. Built using React.js for a dynamic frontend and Appwrite services for robust backend support, VissiPass empowers organizations with a reliable, transparent, and hassle-free visitor management solution.

📑 Table of Contents

🛠 Tech Stack

  • Frontend: React.js
  • Backend: Appwrite
    • Appwrite Services Used: Storage, Auth, Database, Functions
    • Authentication: OAuth2 (Google, GitHub) and Appwrite’s Autonomous Auth
    • Mailserver: Resend, Node, Express

🧩 Modules

Admin/Operator Module

  • Dashboard: Centralized control panel for managing visitor passes and requests.
  • Generate Pass: Allows operators to issue visitor passes.
  • Activate Pass: Track and activate visitor passes for security.
  • Request Handling: Streamlines incoming pass requests.
  • Notifications: Real-time notifications for pass status updates.

User Module

  • Pass Request: Direct, login-free pass request option for a visitor-friendly experience.

🎟 Pass Information

Each digital pass generated by VissiPass includes:

  • Visitor’s Image
  • Name
  • Email
  • Visit Purpose
  • Date and Duration of Visit
  • Visit Type (e.g., meeting, delivery, event)

🚀 Features

  • Secure Access and Permissions: Using Appwrite's authentication, VissiPass keeps visitor data protected and secure.
  • Customizable Pass Fields: Information fields can be tailored to meet organizational requirements.
  • Real-Time Tracking: Notifications and QR code-based tracking for live status and updates.
  • Intuitive UI: Easy-to-use, responsive interface designed for both operators and visitors.
  • No Login for Visitors: Streamlined access without the need for visitor login.

🛠️ Setup

  1. Clone the repository:

    git clone https://github.com/Khushalsarode/appwrite-hackathon/
cd vissipass

  2. Install dependencies:

    npm install

  3. Configure Appwrite:

    • Replace placeholders with your Appwrite project credentials:
      • App ID, API Keys
      • Database ID
      • Auth/Storage service keys

  4. Run the application:

    npm start

🔗 Links

🤝 Contributing

We’re open to contributions! To get involved:

  1. Fork the repository
  2. Clone the repository
  3. Create a new branch: git checkout -b feature-branch
  4. Make your changes and commit: git commit -am 'Add new feature'
  5. Push to the branch: git push origin feature-branch
  6. Open a Pull Request

Please review our Contribution Guidelines and follow the Code of Conduct.

📝 Code of Conduct

Our Project is guided by the Contributor Covenant Code of Conduct. Please respect these guidelines, and reach out to us at khushalsarode@gmail.com if you have any concerns.

📜 License

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

🙋 Maintainer

📚 Open Source Documentation

For a deeper dive into contributing and understanding the project:

Thank you for helping make visitor management smarter and more organized with VissiPass! 🎉