Table of Contents

• Table of Contents
• About
• Features
• Tech Stack
• Installation
• Usage
• Project Structure
• API Endpoints
• Environment Variables
• Contributing
• License

About

Ingress is an easy-to-use MVP (Minimum Viable Product) for entry management. It was built using Node.js and MongoDB database with Mongoose ODM. The application uses EJS (Embedded JavaScript templates) for server-side rendering and supports sending emails and SMS notifications using the Nodemailer module and Nexmo API, respectively.

This project was implemented as a submission for the summergeeks 2020 internship challenge by Innovacer. It meets all the criteria mentioned in the assignment provided by summergeeks.

Features

• User authentication (register, login, logout)
• Host dashboard for managing visitors
• Add new visitors
• Check-in and check-out functionality
• Email notifications to hosts upon visitor check-in
• SMS notifications to hosts upon visitor check-in
• Email notifications to visitors upon check-out
• Responsive design using Tailwind CSS

Tech Stack

• Backend: Node.js, Express.js
• Database: MongoDB with Mongoose ODM
• Frontend: EJS templates, Tailwind CSS
• Authentication: Passport.js
• Notifications: Nodemailer (Email), Nexmo API (SMS)

Installation

1. Clone the repository:

   git clone https://github.com/code-monk08/entry-management.git
   cd entry-management

2. Install dependencies:

   npm install

3. Set up environment variables: Create a .env file in the root directory and add the following variables:

   PORT=5000
   SECRET=your_secret_key
   EMAIL=your_email@gmail.com
   PASSWORD=your_email_password
   NEXMOAPIKEY=your_nexmo_api_key
   NEXMOAPISECRET=your_nexmo_api_secret
   

4. Start MongoDB:

   mongod

5. Run the application:

   npm start

Usage

1. Open your browser and navigate to http://localhost:5000
2. Register as a new host or login if you already have an account
3. Use the dashboard to add visitors and manage check-ins/check-outs

Project Structure

.
├── app.js                 # Main application file
├── config/                # Configuration files
│   ├── auth.js            # Authentication middleware
│   ├── keys.js            # Database configuration
│   └── passport.js        # Passport.js configuration
├── models/                # Database models
│   ├── Host.js            # Host model
│   └── Visitor.js         # Visitor model
├── routes/                # Route handlers
│   ├── hosts.js           # Host-related routes
│   └── index.js           # Main routes
├── views/                 # EJS templates
│   ├── dashboard.ejs      # Dashboard view
│   ├── layout.ejs         # Main layout
│   ├── login.ejs          # Login view
│   ├── register.ejs       # Registration view
│   ├── welcome.ejs        # Welcome page
│   └── partials/          # Partial views
│       └── messages.ejs   # Flash messages partial
├── public/                # Static files
│   └── styles/            # CSS files
├── .env                   # Environment variables
├── package.json           # Project dependencies
└── README.md              # Project documentation

API Endpoints

• GET /: Welcome page
• GET /dashboard: Host dashboard (requires authentication)
• POST /visitors: Add a new visitor
• POST /visitor/:id/checkin: Check-in a visitor
• POST /visitor/:id/checkout: Check-out a visitor
• GET /hosts/login: Login page
• GET /hosts/register: Registration page
• POST /hosts/register: Register a new host
• POST /hosts/login: Authenticate a host
• POST /hosts/logout: Logout a host

Environment Variables

• PORT: The port number on which the server will run
• SECRET: Secret key for session management
• EMAIL: Email address for sending notifications
• PASSWORD: Password for the email account
• NEXMOAPIKEY: Nexmo API key for SMS notifications
• NEXMOAPISECRET: Nexmo API secret for SMS notifications

Contributing

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

Please make sure to update tests as appropriate and adhere to the Code of Conduct.

License

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

---

For any questions or support, please open an issue or contact the maintainer.