Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/khushalsarode/vissipass-appwrite-hackathon

VISSIPASS!: An project for dynamic Visitors Pass Generation using automated way and management of pass with date time and QR CODE
https://github.com/khushalsarode/vissipass-appwrite-hackathon

appwrite appwrite-backend appwrite-hackathon backend-service hacktoberfest hacktoberfest2024 reactjs web

Last synced: 4 days ago
JSON representation

VISSIPASS!: An project for dynamic Visitors Pass Generation using automated way and management of pass with date time and QR CODE

Awesome Lists containing this project

README 

        
# 🎫 VissiPass

**Your Easy Path to a Civilized Visitor Management Experience!** 
 



![React](https://img.shields.io/badge/frontend-react-blue?logo=react&logoColor=white)

![Appwrite](https://img.shields.io/badge/backend-appwrite-red?logo=appwrite&logoColor=white)

![License](https://img.shields.io/badge/license-Apache%202.0-blue)



 

![Docs](https://img.shields.io/badge/docs-complete-brightgreen)

![Issues](https://img.shields.io/github/issues/khushalsarode/appwrite-hackathon)

![Forks](https://img.shields.io/github/forks/khushalsarode/appwrite-hackathon?style=social)

![Stars](https://img.shields.io/github/stars/khushalsarode/appwrite-hackathon?style=social)

![Last Commit](https://img.shields.io/github/last-commit/khushalsarode/appwrite-hackathon)



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](#tech-stack)

- [Modules](#modules)

- [Pass Information](#pass-information)

- [Features](#features)

- [Setup](#setup)

- [Links](#links)

- [Contributing](#contributing)

- [Code of Conduct](#code-of-conduct)

- [License](#license)

- [Maintainer](#maintainer)

- [Open Source Documentation](#open-source-documentation)



---



## 🛠 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**:

   ```bash

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

   cd vissipass

   ```



2. **Install dependencies**:

   ```bash

   npm install

   ```



4. **Configure Appwrite**:

   - Replace placeholders with your **Appwrite project credentials**:

      - App ID, API Keys

      - Database ID

      - Auth/Storage service keys



5. **Run the application**:

   ```bash

   npm start

   ```



## 🔗 Links

- **Demo Video**: [YouTube](https://youtu.be/Qmpllvp_ccc)

- **Hackathon Event**: [Appwrite Hackathon](https://appwrite.io/blog/post/appwrite-hacktoberfest-hackathon-2024)

- **Hacktoberfest 2024**: [Hacktoberfest](https://hacktoberfest.com/participation/)



## 🤝 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](./CONTRIBUTING.md:) and follow the [Code of Conduct](./CODE_OF_CONDUCT.md).



## 📝 Code of Conduct

Our Project is guided by the Contributor Covenant Code of Conduct. Please respect these guidelines, and reach out to us at [email protected] if you have any concerns.



## 📜 License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.



## 🙋 Maintainer

- **GitHub**: [@khushalsarode](https://github.com/khushalsarode)



## 📚 Open Source Documentation

For a deeper dive into contributing and understanding the project:

- **Contribution Guidelines**: Tips for contributing to VissiPass.

- **Code of Conduct**: Expected behavior for contributors.

- **Issues**: [Report issues here](./.github/ISSUE_TEMPLATE/feature_request.yaml)

- **Pull Requests**: [Submit improvements here](./.github/pull_request_template.md)



---



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



---