You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-1Lines changed: 38 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,4 +37,41 @@ Firecrest-UI includes UI components that may be derived from Tailwind UI, a prod
37
37
- If you have purchased a Tailwind UI license, you may use its components **for your own projects or client work** but **cannot redistribute** them as open-source.
38
38
- Ensure that any UI components included in Firecrest-UI are either custom-built or derived from freely available Tailwind CSS styles.
39
39
40
-
For more details, please refer to the [Tailwind UI License](https://tailwindui.com/license).
40
+
For more details, please refer to the [Tailwind UI License](https://tailwindui.com/license).
41
+
42
+
# Development
43
+
44
+
## Local UI development with a local FirecREST environment
45
+
46
+
To simplify running FirecREST locally we provide a set of local Docker environments that already contain all required dependencies. Please make sure [Docker](https://www.docker.com/) is installed and running on your machine.
47
+
48
+
### Configuration
49
+
50
+
Please ensure that the FirecREST Docker Compose environment is running. To connect the UI with the backend, you need to create a ```.env``` file (refer to the provided env_example file for guidance).
51
+
52
+
### Authx
53
+
54
+
The FirecREST environment includes a set of default access configurations (Keycloak settings) that enable the UI to authenticate with an IDM.
55
+
56
+
### Compile and run the web application
57
+
58
+
The requirements for the web app development are node and yarn.
59
+
```shellscript
60
+
node --version
61
+
npm install -g corepack
62
+
yarn --version
63
+
```
64
+
65
+
Once the libraries are available
66
+
```shellscript
67
+
yarn install
68
+
yarn run dev
69
+
```
70
+
71
+
Open the UI on http://localhost:3000/, a login page (Keycloak) should show up.
0 commit comments