Skip to content

jpstone/interview-test-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Front End Interview Test API

Usage

This fake server uses faker.js and json-server in order to serve up fake data for our front end test.

Run default server with npm start, this will serve up the contents in db.json.

You may create a new db.json file by running the generateDB.js file and adjusting the numberOfEntries value contained inside it (minimum number of entries is 100).

We will be checking the final submission against the final-test.json file.

You may launch the server with the final-test.json file by running npm run check.

Data Shapes

The API route that serves the location data is http://localhost:8001/locations, and the data it serves up is of shape:

{
    "id": 0,
    "address": "293 Ova Extensions Koelpinstad New Hampshire, 86680-5255",
    "beds": 2,
    "baths": 0,
    "buildingType": "singleFamily"
}

The API route that serves the building types is http://localhost:8001/buildingTypes. The response is:

[
  "multiFamily",
  "condo",
  "business",
  "office",
  "singleFamily"
]

The API route for all subscriptionPlans is http://localhost:8001/subscriptionPlans. The response is:

[
  {
    "id": 1,
    "maxTrackedItems": 100,
    "creditsPerHousehold": 3,
    "price": {
      "currency": "",
      "value": "Free",
      "paymentInterval": ""
    },
    "additionalFeatures": [
      "Sell Scores"
    ]
  },
  {
    "id": 2,
    "maxTrackedItems": 250,
    "creditsPerHousehold": 2.5,
    "price": {
      "currency": "USD",
      "value": "29",
      "paymentInterval": "month"
    },
    "additionalFeatures": [
      "Sell Scores",
      "Value & Equity Maps"
    ]
  },
  {
    "id": 3,
    "maxTrackedItems": 500,
    "creditsPerHousehold": 1.5,
    "price": {
      "currency": "USD",
      "value": "99",
      "paymentInterval": "month"
    },
    "additionalFeatures": [
      "Sell Scores",
      "Value & Equity Maps"+
    ]
  },
  {
    "id": 4,
    "maxTrackedItems": 10000,
    "creditsPerHousehold": 1,
    "price": {
      "currency": "USD",
      "value": "199",
      "paymentInterval": "month"
    },
    "additionalFeatures": [
      "Sell Scores",
      "Value & Equity Maps"
    ]
  }
]

The API route for all users is http://localhost:8001/user. You can request a single user object by appending the id to the previous URL like so: http://localhost:8001/user/1. The data shape for a user is:

{
  "id": 1,
  "userPlan": {
    "planId": 1
  }
}

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published