From a37283c716baf178c65b7fed99d4dada4bf6f3a7 Mon Sep 17 00:00:00 2001
From: Marc-Antoine Godde <marcantoineg@padok.fr>
Date: Thu, 9 Nov 2023 15:45:31 +0100
Subject: [PATCH] feat(ui): add doc (#190)

---
 ui/Dockerfile |  4 ++--
 ui/README.md  | 33 ++++++++++++++-------------------
 2 files changed, 16 insertions(+), 21 deletions(-)

diff --git a/ui/Dockerfile b/ui/Dockerfile
index 8ad3b5ae..47b2d8fd 100644
--- a/ui/Dockerfile
+++ b/ui/Dockerfile
@@ -3,8 +3,8 @@ WORKDIR /app
 COPY package.json yarn.lock ./
 RUN yarn install --frozen-lockfile
 COPY . .
-ARG VITE_API_BASE_URL
-ENV VITE_API_BASE_URL=$VITE_API_BASE_URL
+ARG API_BASE_URL
+ENV VITE_API_BASE_URL=$API_BASE_URL
 RUN yarn build
 
 FROM nginx:stable-alpine
diff --git a/ui/README.md b/ui/README.md
index 1ebe379f..6c22fde2 100644
--- a/ui/README.md
+++ b/ui/README.md
@@ -1,27 +1,22 @@
-# React + TypeScript + Vite
+# Burrito UI
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+<img src="https://raw.githubusercontent.com/padok-team/burrito/main/ui/public/favicon.svg" alt="Burrito Logo" width="600" />
 
-Currently, two official plugins are available:
+Web UI for [Burrito](https://github.com/padok-team/burrito).
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+## Getting started
 
-## Expanding the ESLint configuration
+1. Install [NodeJS](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com).
+2. Run `yarn install` to install local prerequisites.
+3. Run `yarn start` to launch the dev UI server.
+4. Run `yarn build` to bundle static resources into the `./dist` directory.
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+## Build Docker production image
 
-- Configure the top-level `parserOptions` property like this:
+Run the following commands to build the Docker image:
 
-```js
-   parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-   },
+```bash
+TAG=latest # or any other tag
+BURRITO_API_BASE_URL=https://burrito.example.cloud/api # or any other API base URL
+docker build -t burrito-ui:$TAG --build-arg API_BASE_URL=$BURRITO_API_BASE_URL .
 ```
-
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list