Skip to content

Commit ac93f99

Browse files
committed
update readme
1 parent f1c4f47 commit ac93f99

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,41 @@ Firecrest-UI includes UI components that may be derived from Tailwind UI, a prod
3737
- 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.
3838
- Ensure that any UI components included in Firecrest-UI are either custom-built or derived from freely available Tailwind CSS styles.
3939

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.
72+
73+
Authenticate with the follwing credentials:
74+
```credentials
75+
client: fireuser
76+
secret: password
77+
```

0 commit comments

Comments
 (0)