Skip to content

Latest commit

 

History

History
67 lines (49 loc) · 3.07 KB

README.md

File metadata and controls

67 lines (49 loc) · 3.07 KB

Inhouse Job Postings - JobHub

Build Status

Description

Provides the recruiter the ability to create and manage postings for applicants to apply.

Job Posting Model

Each job posting has the following attributes:

  • id : A unique ID generated for each user.
    Type: String,
  • recruiter : A Global Unique Identifier for the recruiter.
    Type: String, Required: true
  • title : The title of the position of the job.
    Type: String, Required: true
  • description : The description of the job position.
    Type: String, Required: true
  • location : The location of the job.
    Type: String, Required: true
  • salary : The yearly salary for the position.
    Type: Number, Required: true
  • requirements : All the requirements needed for the job.
    Type: String, Required: true
  • company : The company name.
    Type: String, Required: true
  • start date : The date the applicant will start working.
    Type: String, Required: true
  • end date : The date the applicant will finish working if it is a contract position.
    Type: String
  • posting date : Generated date of the posting.
    Type: String, Required: true
  • deadline : The deadline for the applicant to apply.
    Type: String, Required: true

Getting Started

git clone https://github.com/scrum-gang/inhouse-postings.git
cd inhouse-postings
npm install
npm start

Deployement

Builds are automated using Travis and deployed on Heroku.

There is one Heroku deployments:

Endpoints

Endpoint Method Header Body Output
/posting/create POST "Authorization": "Bearer [INSERT_JWT]" recruiter: String, title: String, description: String, location: String, salary: Number, requirments: String, company: String, start_date: String, end_date: String, posting_date: String, deadline: String Creates a new job posting, returns the posting with the generated id
/posting/id/:id GET Returns the posting with the ID specified in the request
/posting/recruiter/:recruiter GET Returns all postings from the recruiter specified in the request
/posting/allpostings GET Retunrs all the exisiting postings
/posting/:id PUT "Authorization": "Bearer [INSERT_JWT]" recruiter: String, title: String, description: String, location: String, salary: Number, requirments: String, company: String, start_date: String, end_date: String, posting_date: String, deadline: String Updates the posting with the ID from the request and updates the elements in the body that are specified
/posting/dropall DELETE "Authorization": "Bearer [INSERT_JWT]" Deletes all the postings in the collection
/posting/id/:id DELETE "Authorization": "Bearer [INSERT_JWT]" Deletes the posting with the ID from the request