updated docs
This commit is contained in:
parent
8edcbe043f
commit
d7270057f6
43
Google_Maps_App_ReactsJS/Original_README.md
Normal file
43
Google_Maps_App_ReactsJS/Original_README.md
Normal file
@ -0,0 +1,43 @@
|
||||
### React Google Maps Final Project
|
||||
|
||||
A single page React App, featuring google maps, a list of locations with on map markers, a filter locations options for finding locations easier, and a third API for rendering details about the map locations.
|
||||
|
||||
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
|
||||
|
||||
### APIs used in this project
|
||||
- Google Maps API
|
||||
- Zomato API
|
||||
|
||||
### Download and run the project
|
||||
- Download the project file
|
||||
- run $ npm install
|
||||
- run $ npm start
|
||||
The project runs at http://localhost:3000/
|
||||
|
||||
## Project Specifications
|
||||
|
||||
### Interface Design
|
||||
- All application components render on-screen in a responsive manner, and are usable across modern desktop, tablet, and phone browsers.
|
||||
|
||||
### Application Functionality
|
||||
- Includes a text input field or dropdown menu that filters the map markers and list items to locations matching the text input or selection. Filter function runs error-free.
|
||||
|
||||
### List View
|
||||
- A list-view of location names is provided which displays all locations by default, and displays the filtered subset of locations when a filter is applied.
|
||||
- Clicking a location on the list displays unique information about the location.
|
||||
|
||||
### Map and Markers
|
||||
- Map displays all location markers by default, and displays the filtered subset of location markers when a filter is applied.
|
||||
- Clicking a marker displays unique information about a location on the page in a separate div.
|
||||
|
||||
### Asynchronous API Requests
|
||||
- Application utilizes the Google Maps API and Zomato API.
|
||||
- All data requests are retrieved in an asynchronous manner using Fetch API.
|
||||
|
||||
|
||||
### Offline Use
|
||||
- When available in the browser, the site uses a service worker to cache responses to requests for site assets. Visited pages are rendered when there is no network access.
|
||||
|
||||
### Accessibility
|
||||
- Elements on the page use the appropriate semantic elements. For those elements in which a semantic element is not available, appropriate ARIA roles are defined.
|
||||
- All content-related images include appropriate alternate text that clearly describes the content of the image.
|
5
Google_Maps_App_ReactsJS/Readme.md
Normal file
5
Google_Maps_App_ReactsJS/Readme.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Usse
|
||||
|
||||
```bash
|
||||
export NODE_OPTIONS=--openssl-legacy-provider
|
||||
```
|
@ -25,4 +25,11 @@ To use the dockerfile you can simply use the bash script: ``use_docker.sh`` and
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
./use_docker.sh
|
||||
./use_docker.sh
|
||||
|
||||
Several commands are supported:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
./use_docker.sh remove
|
||||
./use_docker.sh recreate
|
Loading…
Reference in New Issue
Block a user