OAuthKeeper

A simple yet functional REST application to manage HR contacts for MOCK PLACEMENTS (2021). It lets only authorized users to view certain contacts. Built with NodeJS, Express, Mongoose and EJS.

Contents

• Motivation
• Features
• Project Setup
• Database Seeder
• Project Structure
• Routes
• Screenshots
• Tools
• Contributors
• Contributing
• LICENSE

Motivation

The Mock Placements is the annual flagship event of the FORum for Economic Studies for Engineers, the placement club at SVCE. The objective of this event is to provide students with information about their strengths and weaknesses before they attend actual campus placements and job interviews. This is achieved by conducting aptitude tests, group discussion and mock interviews with real HR's, giving the students some experience on how the process works. Inviting HR's to the college is one of the most important steps in the organizational process. This is done by letting specific students call and invite recruiters for the event.

However, this process can be chaotic and is inherently prone to problems. Some of the problems that were faced by the organisers are as follows:-

• A student would accidentally call contacts that had already been invited by other students. This results in overlapping of contacts. This leads to HRs and recruiters getting annoyed by getting calls from multiple students.
• Making note of the statuses of HRs for the event (Confirmed, Rejected, Call Postponed, etc) was hard for students as they would have to note it all down somewhere. This would make it hard for the organisers to keep track of the number of HRs coming for the event and their details.
• The organizers were not able to maintain a proper count of the number of HR's who had been invited and this led to confusions among different teams responsible for organizing the event.

There was a need for a solution which would help us get solve all of these problems and hece we built this application.

Features

Student Accounts

• Students who are calling the HR's will have to sign up for an account using their E-Mail ID. The students would then be split into 5 teams, with each team being managed exclusively by an executive director.
• Students would then have the option of adding contacts to the database, provided the HR contact does not already exist in the database. This is taken care of by the solution.
• Students can also update information of contacts that are visible to them such as name, company, number, email, address and, most importantly, status.
• Students can also search and filter contacts on the basis of status and interview which would help them keep of track of their progress.

ED Accounts

• ED's can regsiter and then log into their account to view the contacts added to the database by the students in their team only.
• There are also features which help the ED's to search for and filter contacts based on student-in-charge, status and interview mode (Online and Offline).
• ED's can also view statistics on the number of HRs in each stage (such as 'Not Called', 'Confirmed', etc etc).
• ED's can also generate Excel and PDF files of the data present in the database.

Administrator Accounts

• Administrator accounts enjoy the same privelages as that of the ED accounts and can view all the contacts, and not just the contacts of a particular team.
• An administrator account can be setup only by manually changing the role of a user to "Admin" in the database.

User Features

• All users who register will have to verify their e-mail by clicking on the confirmation link sent to their mail.
• A logged in user can update their password by entering their current password and then creating a new one.
• Incase a user forgots his/her password, they can reset it using the "Forgot Password" feature.

Project Setup

Install dependencies
npm install

Run in development mode
npm run dev

Run in production mode
npm start

Database Seeder

Destroy All Data
node seeder -d

Import All Data
node seeder -i

Project Structure

OAuthKeeper2.0/
  .git                   # Git Source Directory
  node_modules/          # Project Dependencies
  config/                # Database connection helper
  controllers/           # User and Contact controller methods
  middleware/            # Middleware functions
  models/                # Database Schemas and Models
  public/                # Static CSS, JS files and Favicon
  resources/             # Project Specifications and test data
  routes/                # User and Contact routes
  screenshots/           # Screenshots for documentation
  utils/                 # Log Files and other utilities
  views/                 # EJS Templates and Views
  .env                   # Environment Variables
  .gitignore             # Files and folders to be ignored
  app.js                 # Express configuration
  server.js              # Application entry point
  seeder.js              # Seed file to populate and destroy data
  package.json           # Project Description and dependeincies
  package-lock.json      # Lock File
  LICENSE                # MIT License file
  README.MD              # Brief documentation

Routes

Route Name	URL	HTTP Verb	Access	Description
Landing Page	/	GET	Public	Show links for logging in and registration
Register	/users/register	GET	Public	Render form for user registration
Register	/users/register	POST	Public	Register user, then redirect to dashboard
Login	/users/login	GET	Public	Render form for user login
Login	/users/login	POST	Public	Log User In, Then Redirect To Dashboard
Confirm E-Mail	/users/confirmemail?token=token	GET	Public	Verify token, Then Redirect To Dashboard
Forgot Password	/users/forgotpassword	GET	Public	Show form to accept user email
Forgot Password	/users/forgotpassword	POST	Public	Send link to reset password to user e-mail
Update Password	/users/updatepassword	GET	Private	Render form to update existing password
Update Password	/users/updatepassword	PUT	Private	Update password, then redirect to dashboard
Reset Password	/users/resetpassword/:resettoken	GET	Private	Render form to reset password
Reset Password	/users/resetpassword/:resettoken	PUT	Private	Update new password in the DB
Logout	/users/logout	GET	Public	Log User Out / Clear Cookie, Then Redirect to Login
Dashboard	/contacts	GET	Private	Display user dashboard
Tabulated View	/contacts/panel	GET	Private	Display contacts in tablated fashion
Statistics	/contacts/statistics	GET	Private	Display contact statistics for each user
Create	/contacts	POST	Private	Create new contact, then redirect
Update	/contacts/:id	PUT	Private	Update a contact, then redirect
Destroy	/contacts/:id	DELETE	Private	Delete a contact, then redirect

Screenshots

Register Page	Login Page	Update Password Page

Forgot Password Page	Dashboard	Create Contact

Tools

• Visual Studio Code
• NodeJS
• NPM
• MongoDB Atlas

Contributors

• Design and Development - Nilesh D

Contributing

Please feel free to fork, comment, critique, or submit a pull request.

LICENSE

This project is open source and available under the MIT License.