43 refresh packages and code and readme (#44)

* Builk refactor of code

* Package lock update

* Refining map style setup

* Adjusting import path

* Revert path to original

* Renaming linkedidsAPI.js

Author: DaveBathnes

.env.sample

@@ -0,0 +1,2 @@
+REACT_APP_OS_MAP_KEY=
+REACT_APP_API_BASE_URL=

README.md

@@ -27,6 +27,19 @@ npm start
 This runs the app in the development mode.\
 Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
 
+To run the application, the API should also be running.
+
+### Environment variables
+
+In development, environment variables can be set within the `.env` file (can be created by copying the `.env.sample` file). This file is excluded from source control and should never be committed in public code.
+
+During production runtime the environment variables can be set within the build environment e.g. within GitHub actions. As this is a client side project it should be noted that those values will be available within the built code.
+
+| Variable               | Description                            |
+| ---------------------- | -------------------------------------- |
+| REACT_APP_OS_MAP_URL   | A URL for the OS Base Map Tile Service |
+| REACT_APP_API_BASE_URL | A URL for the supporting API           |
+
 ## Deployment
 
 ```console
@@ -46,6 +59,8 @@ who participated in this project.
 
 This project is licensed under the [MIT](LICENSE.md) License - see the [LICENSE.md](LICENSE.md) file for details
 
-## Acknowledgements
+## Acknowledgements and Technologies
 
+- [ReactJS](https://reactjs.org/)
 - [Material UI](https://mui.com/)
+- [MapLibre](https://maplibre.org/)

package-lock.json

@@ -1,24 +1,21 @@
 {
-  "name": "mapup-reactjs",
+  "name": "usemap-reactjs",
   "version": "0.1.0",
   "private": true,
   "homepage": "https://geovation.github.io/usemap-reactjs/",
   "dependencies": {
-    "@emotion/react": "^11.10.4",
-    "@emotion/styled": "^11.10.4",
+    "@emotion/react": "^11.10.5",
+    "@emotion/styled": "^11.10.5",
     "@fontsource/roboto": "^4.5.8",
-    "@mui/icons-material": "^5.10.6",
-    "@mui/material": "^5.10.6",
-    "@testing-library/jest-dom": "^5.16.5",
-    "@testing-library/react": "^13.4.0",
-    "@testing-library/user-event": "^13.5.0",
+    "@mui/icons-material": "^5.11.0",
+    "@mui/material": "^5.11.0",
     "axios": "^0.27.2",
     "mapbox-gl": "npm:empty-npm-package@^1.0.0",
     "maplibre-gl": "^2.4.0",
     "proj4": "^2.8.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
-    "react-map-gl": "^7.0.19",
+    "react-map-gl": "^7.0.20",
     "react-modal": "^3.16.1",
     "react-scripts": "5.0.1",
     "web-vitals": "^2.1.4",