Masai Placement Portal

Live URL

Table of Contents

1. About The Project
   • Artefacts
   • Backend Repo
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Test Credentials
   • Tools And Libraries
3. Contributors

About The Project

This is the Masai Build and Earn Project. We will build an website where Placement team will bring companies from different sources and update them on the portal so that students can apply according to their skill sets. To build this website we have used React, Redux, Express, MongoDB, Ant Design. Alongside doing this project, we learnt a lot of new things about team work, proper coordination and thinking along with all the team members.😊

Artefacts

PRD      HLD      Wireframes      Coding Practices

Backend Repo

Backend Repo

Mission:

Website where Placement team will create companies,positions with eligibility on the portal so that students can view and apply accordingly to their skill sets.

Vision:

Admin create all companies information,positions and eligibility so student wiil get all transparency while applying.

Goals:

• Simple solutions for the problems.
• All Company and their Positions with eligibility are in one place.
• Bridge the communication gap within the Students and the recruiters .

Features:

• Companies and positions can get, add, edit and delete.
• Simple and consistent UI.
• Admin and student panel available as per requirements.
• Secure app with email varification and JWT Token.
• Multiple Details about company and position to clear students required quations.
• Optimization technique makes fast response loading.
• Pagination if long lists.

Built With

Getting Started

Following are the simple steps to run this project.

Prerequisites

• npm

  npm install 

Installation

1. Clone the frontend repo

   git clone https://github.com/masai-builds/team7-fe.git team7-fe

2. Clone the backend repo

   git clone https://github.com/masai-builds/team7-be 

3. Run

   npm start

4. Open http://localhost:3000 to view it in the browser
5. Open http://localhost:8080 to backend run in the browser (npm run dev)

Test Credentials

To login in the app as admin use email demoAdmin@gmail.com and password Admin@123
To login in the app as student use email demoStudent@gmail.com and password Student@123

Tools and Libraries

• [Redux] - State Management
• [Sentry] - Error Tracking
• [React-testing-Library] - Integration testing
• [AntDesign] - CSS styling classes
• [nodeJs] - Server environment
• [ExpressJs] - Routing, middleware
• [JWT] - JSON Web Token for authorization and authentication
• [Swagger] = API Developer tool
• [Winston] - App logging
• [redis] - Response optimization

Contributors ✨

Pankaj Kumar Ram

Shreenath Panchal

Pratik Ganjale

Saraswati Panda

Dhiraj Dubey