Changes
Page history
Auto-updated file in CI
authored
Nov 26, 2023
by
Firat Yusuf Duran
Show whitespace changes
Inline
Side-by-side
home.md
View page @
b5bdad74
...
...
@@ -22,8 +22,9 @@
-
[
Customize configuration
](
#customize-configuration
)
-
[
Project setup
](
#project-setup
)
-
[
Compile and hot-reload for development
](
#compile-and-hot-reload-for-development
)
-
[
Set up environment variables
](
#set-up-environment-variables
)
-
[
Type-Check, compile and minify for production
](
#type-check-compile-and-minify-for-production
)
-
[Setup SSH-Tunnel]
-
[
Setup SSH-Tunnel
]
(
#setup-ssh-tunnel
)
-
[
Build cocumentation with TypeDoc
](
#build-documentation-with-typedoc
)
-
[
Run unit tests with Vitest
](
#run-unit-tests-with-vitest
)
-
[
Run integration tests with Playwright
](
#run-integration-tests-with-playwright
)
...
...
@@ -110,10 +111,12 @@ axii workspace upgrade
#### You can use the frontend with following commands:
Host the website locally on a server (if asked to install dependencies, answer with "y"):
[ options: -h | --help, -p | --port, -u | --url ]
```
sh
fluxio_frontend_run_server
```
Start the frontend in a dev environment (local server with hot reload):
[ options: -h | --help, -p | --port, -u | --url ]
```
sh
fluxio_frontend_dev
```
...
...
@@ -125,6 +128,7 @@ Update the npm packages used:
```
sh
fluxio_frontend_install
```
For more information about the backend mock and how to use it please look
[
here
](
https://git.h2t.iar.kit.edu/sw/armarx/core/fluxio/backend-mock
)
### Troubleshooting
...
...
@@ -206,6 +210,11 @@ npm install
npm run dev
```
#### Set up environment variables
1.
`API_BASE_URL=$URL`
The base url for api request. (replace $URL with the actual url)
2.
`PORT=$PORT`
The port specifies the port for the frontend to run on. (replace $PORT with an actual port number)
#### Type-Check, compile and minify for production
```
sh
...
...
...
...