Project Name

Project description

Related Projects

• https://github.com/team-frontend/image-carousel
• https://github.com/team-frontend/detailed-part
• https://github.com/team-frontend/mortgage-calculator

Table of Contents

1. Usage
2. Getting Started
3. Requirements
4. Development
5. API Endpoints

Usage

Some usage instructions

Requirements

An nvmrc file is included if using nvm.

• Node 6.13.0
• MySQL 5.7.23

Development

Installing Dependencies

From within the root directory:

npm install -g webpack
npm install

Create the database neighborhood by executing this file from the command line by typing:

mysql -u root < database/schema.sql 

Start the server with:

npm start

Start your application with:

npm run dev

Running Tests

This project is Jest and Enzyme based test You can run them by npm run test:watch

API Documentation

Public End Points

Description	Endpoint
Get Info of Nearby Homes of a Home	GET /api/homes/:homeId/nearbyHomes

GET /api/homes/:homeId/nearbyHomes

Requests home's nearby homes information upon accessing from Zillow's designated endpoint

Example Request

Example Response