[doc] add frontend README.md, update python README.md

README.md

@@ -8,6 +8,10 @@ pinned: false
 license: mit
 ---
 
+# About this README
+
+I tested these instructions on MacOS, but should work on linux as well.
+
 ## Segment Anything models
 
 It's possible to prepare the model files using <https://github.com/vietanhdev/samexporter/> or using the ones
@@ -49,7 +53,7 @@ Test it with curl using a json payload:
 
 ```bash
 URL=http://localhost:7860/infer_samgis
-curl -d@./events/payload_point_eolie.json -H 'accept: application/json' ${URL}
+curl -d@./events/payload_point_eolie.json -H 'content-type: application/json' ${URL}
 ```
 
 or better visiting the swagger page on <http://localhost:7860/docs>
@@ -80,7 +84,7 @@ Test it with curl using a json payload:
 
 ```bash
 URL=http://localhost:8080/2015-03-31/functions/function/invocations
-curl -d@./events/payload_point_eolie.json -H 'accept: application/json' ${URL}
+curl -d@./events/payload_point_eolie.json -H 'content-type: application/json' ${URL}
 ```
 
 ### Publish the aws lambda docker image
@@ -88,10 +92,26 @@ curl -d@./events/payload_point_eolie.json -H 'accept: application/json' ${URL}
 Login on aws ECR with the correct aws profile (change the example `example-docker-namespace/` repository url with the one from
 the [ECR push command instructions page](https://eu-west-1.console.aws.amazon.com/ecr/repositories/)).
 
-### Dependencies installation and local tests
+### Dependencies installation, local execution and local tests
+
+The docker build process needs only the base dependency group plus the `aws_lambda` or `fastapi` optional one (right now I use almost only the `fastapi` version). Install also the `test` and/or `docs` groups if needed.
+
+#### Local execution
+
+If you need to use the SPA frontend follow the frontend instruction [here](/static/README.md).
+
+You can run the local server using this python command:
 
-The docker build process needs only the base dependency group plus the `aws_lambda` or `fastapi` optional one.
-Install also the `test` and/or `docs` groups if needed.
+```python
+uvicorn wrappers.fastapi_wrapper:app --host 127.0.0.1 --port 7860
+```
+
+Change the port and/or the host ip if needed. Test it with curl using a json payload:
+
+```bash
+URL=http://localhost:7860/infer_samgis
+curl -d@./events/payload_point_eolie.json -H 'content-type: application/json' ${URL}
+```
 
 ### Tests
 

static/README.md

@@ -1,36 +1,26 @@
-# ml-tornidor
+# SamGIS frontend
 
-## Local development
+This is the [SPA](https://wikipedia.org/wiki/Single-page_application) frontend for [SamGIS](https://github.com/trincadev/samgis-be).
 
-Since I use Cloudflare pages as hosting for this project there are some required steps to do before it's possible to start a local development environment. This project needs to wrap the node commands with the `npx wrangler [...]` utility to emulate a Cloudflare Worker function. Because this worker function is under auth which use some env variables I to write these env variables inline. Every time I changed or added needed some variables I also needed to update the `npx wrangler` command. To avoid this I prepared a js script, executed by [Deno](https://deno.land/), that read the env variables from the `.env` file composing the command:
+## Requirements
 
-1. prepare the .env file copying the template.env file
-2. run the local environment using the command `pnpm dev` or `deno run -A runner.js`
+1. a recent nodejs version (I'm using nodejs 20 now)
+2. `pnpm`
 
-In case of new or updated packages Deno installs the dependencies at the first execution. Do it with a execution  without the `npx wrangler` wrapper:
+Then execute from this folder (`static/`):
 
-```bash
-deno run -A --node-modules-dir npm:vite
-```
-
-In case of problem:
-
-1. try executing again the command `deno run -A --node-modules-dir npm:vite`
-
-If this don't solve the problems try to
-
-1. delete the node_modules folder
-2. reinstall the npm packages with `pnpm install`
-3. Run again the local development server, this time with the standard command
-
-Before to commit try also to build using
-
-```bash
+```nodejs
+npm install -g pnpm
+pnpm install
 pnpm build
+pnpm tailwindcss -i $PWD/src/input.css -o $PWD/dist/output.css
 ```
 
-Then run the preview (change the example variables):
+## Dependencies
 
-```bash
-npx wrangler pages dev --binding VITE_AUTH0_DOMAIN="example-auth0.eu.auth0.com" API_URL="https://example-aws.execute-api.eu-west-1.amazonaws.com/localhost/lambda-ml-fastsam-api" VITE_AUTH0_AUDIENCE="http://localhost-ml-lambda/" API_DOMAIN=example-aws.execute-api.eu-west-1.amazonaws.com CORS_ALLOWED_DOMAIN=http://localhost:8788 VITE_SATELLITE_NAME="tile-provider.image-type" -- pnpm preview
-```
+- [driver.js](https://github.com/trincadev/driver.js/)
+- [leaflet](https://leafletjs.com/)
+- [tailwind](https://tailwindcss.com/)
+- [typescript](https://www.typescriptlang.org/)
+- [vuejs](https://vuejs.org/)
+- [vite](https://vitejs.dev/)