google-map-lookup

Description

Table of Contents

• Features
• Requirements
• Usage

Features

• View All Address
• View Individual Address location on Google Map
• View Individual Address Details (State, Country) on Marker Click (on Google Map)

Requirements

Make sure you have installed all of the following prerequisites on your development machine:

• Git - Download & Install Git. MacOS and Linux machines typically have this already installed.

• Node.js - Download & Install Node.js and the npm package manager. Make sure to get the latest active LTS version.

• Download the Google-Map-Lookup from this link or use git clone git@github.com:Babanila/google-map-lookup.git.

How to start the frontend app

• Go to your terminal.
• Locate the downloaded google-map-lookup directory.
• Change the directory to the google-map-lookup directory(e.g cd google-map-lookup).
• Run yarn install.
• Export the Google Api Key as API_KEY to the terminal environment (e.g export API_KEY="XXXXXXXXXXXXXXXXXX")
• To start the app, run yarn start on your terminal.

Usage

To use the app , follow the steps below.

STEPS

• Open a web browser (It will open automatically)
• Enter the localhost address using port 8080 (e.g http://localhost:8080).
• View at all the addresses in the address list.
• Click on any address to see the location on Google map.
• Click on the location marker (the black dot on the red shape) to view the location details.
• Clickon the back button to return to the home page.
• E.t.c

To run unit tests

• From the root directory, run yarn test

For Production

• From the root directory, run yarn build

Finish