https://github.com/sayak119/vms

Visiter Mangement System
https://github.com/sayak119/vms

django reactjs sendgrid-api textlocal visitor-management

Last synced: about 1 month ago
JSON representation

Visiter Mangement System

• Host: GitHub
• URL: https://github.com/sayak119/vms
• Owner: sayak119
• Created: 2019-11-28T08:01:21.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-11-28T10:34:11.000Z (about 6 years ago)
• Last Synced: 2025-03-12T06:44:22.421Z (11 months ago)
• Topics: django, reactjs, sendgrid-api, textlocal, visitor-management
• Language: JavaScript
• Size: 1.05 MB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Visitor Management System (VMS)

The doc can be found [here](https://summergeeks.in/static/assignments/summergeeks%202020%20-%20SDE%20Assignment.pdf). I added an extra feature regarding the checkout option by making use of unique tokens. When a guest checks in, they are given a unique token too. So that while checking out, they can enter it into the system. An admin page has also been added for monitoring. In this project, **Sendgrid** and **Textlocal** for the task of sending email and sending SMS to the parties involved. Also added the count of guests at any moment in the building.

* For **Textlocal** go through the docs present [here](https://api.textlocal.in/docs/).

* For **Sendgrid** go through the docs present [here](https://github.com/sendgrid/sendgrid-python).

## Machine Configuration

* Operating System - Ubuntu 18.04 (LTS)

* Python version - 3.6.8

### Tech Stack

The System uses a number of open source projects to work properly:

* Django - BackEnd

* React - FrontEnd

* Database - MongoDB

### Installation

Install MongoDB

```sh

$ wget -qO - https://www.mongodb.org/static/pgp/server-4.2.asc | sudo apt-key add -

$ sudo apt-get install gnupg

$ wget -qO - https://www.mongodb.org/static/pgp/server-4.2.asc | sudo apt-key add -

$ echo "deb [ arch=amd64 ] https://repo.mongodb.org/apt/ubuntu bionic/mongodb-org/4.2 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.2.list

$ sudo apt-get update

$ sudo apt-get install -y mongodb-org

$ sudo apt-get update

```

### Running

* Run MongoDB

```sh

$ sudo service mongod start

```

* Create the Virtual Environment

```sh

$ python3 -m venv env

$ source env/bin/activate

```

* And in the virtual environment Run Backend

```sh

$ pip3 install -r requirments.txt

$ python3 manage.py makemigrations

$ python3 manage.py migrate

$ python3 manage.py runserver

```

* Run test

```sh

$ python3 manage.py test

```

* Run Frontend

```sh

$ npm install

$ npm start

```

* URLs

```

Host - localhost:3000/host

Checkin/Checkout - localhost:3000

Admin - 127.0.0.1:8000/admin

```

## Screenshots

* Host

![Host](screenshots/host.png)

* Check-in

![Check-in](screenshots/checkin.png)

* Check-out

![Check-out](screenshots/checkout.png)

* Admin (Guest not checked out)

![Admin not checked out](screenshots/admin-not_checked_out.png)

* Admin (Guest checked out)

![Admin checked out](screenshots/admin-checked_out.png)

* Updating host about guest

![Sending host update](screenshots/sending_host_update.png)

* Sending guest token on email

![Sending guest token on email](screenshots/sending_guest_token.png)

* Sending final email when guest exits

![Sending final email when guest exits](screenshots/thanks_for_visiting_email.png)

* Guest checkout token via SMS

![Guest checkout token via SMS](screenshots/guest_token.png)

* Informing Host about Guest checkin via SMS

![Informing Host about Guest checkin via SMS](screenshots/host_SMS.png)