From d7270057f6d3f46507f1143e5806fb95a27957b5 Mon Sep 17 00:00:00 2001 From: Eljakim Herrewijnen Date: Thu, 28 Dec 2023 22:09:56 +0100 Subject: [PATCH] updated docs --- Google_Maps_App_ReactsJS/Original_README.md | 43 +++++++++++++++++++++ Google_Maps_App_ReactsJS/Readme.md | 5 +++ documentation/source/app.rst | 9 ++++- 3 files changed, 56 insertions(+), 1 deletion(-) create mode 100644 Google_Maps_App_ReactsJS/Original_README.md create mode 100644 Google_Maps_App_ReactsJS/Readme.md diff --git a/Google_Maps_App_ReactsJS/Original_README.md b/Google_Maps_App_ReactsJS/Original_README.md new file mode 100644 index 00000000..6f28f4e3 --- /dev/null +++ b/Google_Maps_App_ReactsJS/Original_README.md @@ -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. diff --git a/Google_Maps_App_ReactsJS/Readme.md b/Google_Maps_App_ReactsJS/Readme.md new file mode 100644 index 00000000..8afaec6e --- /dev/null +++ b/Google_Maps_App_ReactsJS/Readme.md @@ -0,0 +1,5 @@ +# Usse + +```bash +export NODE_OPTIONS=--openssl-legacy-provider +``` \ No newline at end of file diff --git a/documentation/source/app.rst b/documentation/source/app.rst index 8126d6c8..d1d829e2 100644 --- a/documentation/source/app.rst +++ b/documentation/source/app.rst @@ -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 \ No newline at end of file + ./use_docker.sh + +Several commands are supported: + +.. code-block:: bash + + ./use_docker.sh remove + ./use_docker.sh recreate \ No newline at end of file