actuallyitsnathaniel / lightfeather-backend-challenge

My entry for LightfeatherIO. Written in ExpressJS, tested with Insomnia.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Lightfeather Back-End Challenge

This back-end program exposes an API in order to retrieve a list of supervisors and submit personal information.

It is an exclusively back-end application. In order to use it, some level of experience with an API-testing workspace is required. I recommend either Insomnia or Postman.

Installation:

$ git clone https://github.com/actuallyitsnathaniel/lightfeather-backend-challenge.git

$ cd lightfeather-backend-challenge

$ npm install

Usage:

You should be in the root directory of the repository after installing.
Then, type:

$ nodemon .

Open your preferred API Workspace of choice (e.g. Insomnia or Postman) and make sure your requests go to:

localhost:8080/

When performing a GET, ensure that your address is set to:

localhost:8080/api/supervisors

When performing a POST, ensure that your address is set to:

localhost:8080/api/submit

And ensure your JSON format is as follows:

{
	"firstName": "First",
	"lastName": "Last",
	"email": "email@mail.mail",
	"phoneNumber": "123-456-7890",
	"supervisor": "Super Visor"
}

^^ firstName, lastName, and supervisor are required fields.

About

My entry for LightfeatherIO. Written in ExpressJS, tested with Insomnia.


Languages

Language:JavaScript 100.0%