Englopers-Team/jobify-backend

Jobify-app

Group members

• Abdallah Zakaria
• Abdulhakim Zatar
• Mohmmad Al-Esseili
• Osama Althabteh

Problem Domain

Day after day, unemployment has become a big issue that threatens everyone, especially in the hard circumstances that the world is going through due to COVID19 pandemic, although that there are too many websites that help people find jobs, they are too many to follow and a bit complicated in some way , so our plan is to make an employment hub that combine all jobs from different sources in one place and make this process as much easier as it could be.

UML

Database Model Diagram

Project Management Tool

Trello

Features & Routes

Applicant

Dashboard

Method	Endpoint	Description
GET	/home	Used to get the suggestion jobs, the number of applied applications, the received offers, messages, and the notifications.

Applications

Method	Endpoint	Description
GET	/user/app	Used to get all the employee applied applications.
GET	/user/app/:id	Used to get one of the employee applied applications.
DELETE	/user/app/:id	Used to delete one of the applied applications.

Offers

Method	Endpoint	Description
GET	/user/offers	Used to get all the employee received offers.
PUT	/user/offers/:id	Used to answer one of the received offers

Apply

Method	Endpoint	Description
POST	/user/apply/:id	Used to apply on a job offer.

Search

Method	Endpoint	Description
GET	/job	Used to search for a job by the job title and location.
GET	/company	Used to search for a company by the title and location.

Save

Method	Endpoint	Description
GET	/user/saved	Used to get all the employee saved jobs.
POST	/user/save	Used to save one of jobs.

Reports

Method	Endpoint	Description
POST	/report	Used to send a report to the support.
GET	/reports	Used to get all the employee reports.
GET	/report/:id	Used to get one of the employee reports.

Upload

Method	Endpoint	Description
POST	/upload/profile_pic	Used to upload the employee profile picture.
POST	/upload/cv	Used to upload and scan the employee resume.

Edit Profile

Method	Endpoint	Description
PUT	/user/edit	Used to update the employee profile information.

Company

Dashboard

Method	Endpoint	Description
GET	/home	Used to get all the company job applications, job offers, messages, and the notifications.

Applications

Method	Endpoint	Descriptions
GET	/company/app	Used to get all the company received applications.
PUT	/company/app/:id	Used to answer one of the received application.

Offers

Method	Endpoint	Description
GET	/company/offers	Used to get all the company sent offers.
POST	/company/offers/:id	Used to send a new offer.
DELETE	/company/offers/:id	Used to delete one of the company sent offers.

Jobs

Method	Endpoint	Description
GET	/company/jobs	Used to get all the company posted jobs.
POST	/company/submit	Used to post new job.
PUT	/company/jobs/:id	Used to update one of the company posted jobs.
DELETE	/company/jobs/:id	Used to delete one of the company posted jobs.

Search

Method	Endpoint	Description
GET	/employee	Used to search for employees by the job title and location.

Reports

Method	Endpoint	Description
POST	/report	Used to send a report to the support.
GET	/reports	Used to get all the company reports.
GET	/report/:id	Used to get one of the company reports.

Edit Profile

Method	Endpoint	Description
PUT	/company/edit	Used to update the company profile information.

Admin

Dashboard

Method	Endpoint	Description
GET	/	Used to get all the website statistics.

Block

Method	Endpoint	Description
PATCH	/admin/block/:id	Used to ban users.
PATCH	/admin/removeBlock/:id	Used to Unban users.

Reports

Method	Endpoint	Description
GET	/admin/report	Used to get all the received reports from employees and companies.
GET	/admin/report/:id	Used to get one of the received reports from employees and companies.
PATCH	/admin/report/:id	Used to update one of the received reports from employees and companies.
DELETE	/admin/report/:id	Used to delete one of the received reports from employees and companies.

Posts

Method	Endpoint	Description
GET	/admin/posts	Used to get all the posted posts from community.
GET	/admin/posts/:id	Used to get one of the posted posts from community.
PATCH	/admin/posts/:id	Used to pin one of the posted posts from community.
DELETE	/admin/posts/:id	Used to delete one of the posted posts from community.

Seed Data

Method	Endpoint	Description
POST	admin/seed	Used to insert post jobs by the admin to the platform.

Community

Dashboard

Method	Endpoint	Description
GET	/	Used to get all data for the user.
GET	/search	Used to search for a post by typing keywords related to the subject.

Post

Method	Endpoint	Description
GET	/post/:id	Used to get an added Post .
POST	/submit	Used to post submit new post.
PATCH	/post/:id	Used to update an added post.
DELETE	/post/:id	Used to delete an added post

Comment

Method	Endpoint	Description
POST	/comment/:id	Used to post a new comment on an added Post .
DELETE	/comment/:id	Used to delete an added comment.

Like

Method	Endpoint	Description
POST	/like/:id	Used to add a new like on an added Post .

Authentication

Basic authenticate

Method	Endpoint	Description
POST	/signin	Authorize users to the platform.
POST	/signup	Register user as recruiter or applicate.
GET	/logout	Logout user from platform and clear his/her cookies.

Verify

Method	Endpoint	Description
GET	/verify/:token	Verify user by generated token sent to his/her email.

Messages

Listening to messages namespace

• The company can start offer-chat with any employee in the platform then the employee will be able to chatting with that company in real time event.
• When the user get back online all of unseen messages will appear.
• User will have the ability to get the messages history.

Notifications

Listening to notification namespace

• The employee will notified in real time event when received a job offer.
• the company will notified in real time event when received a job application.
• User will have the ability to get the notification history.

API

Fetching data from other's platform

Method	Endpoint	Description
GET	/api/v1/jobs	Used to fetch all jobs in the platform.
GET	/api/v1/companies	Used to fetch all companies in the platform.
GET	/api/v1/employees	Used to fetch all employee in the platform.

Tests

Technology

Deployed app link

Link