Skip to content

Commit baa8df3

Browse files
committed
[312] Update readme for local development
1 parent 8221aa6 commit baa8df3

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,22 @@ cp ENV.local .env
2727

2828
npm run build
2929
```
30-
You can find the builded version into terminusdb-dashboard/packages/tdb-dashboard/dist
30+
You can find the built version into terminusdb-dashboard/packages/tdb-dashboard/dist
31+
32+
**Locally Developing the dashboard**
33+
34+
Running `npm run start` instead of `build` starts a server and watches for changes. Because of the way this is configured, you will need to go to `/dashboard` after connecting in browser
35+
36+
```sh
37+
npm run start
38+
```
39+
40+
There are some differences depending on how you are developing it, if you are just running the dashboard repo locally:
41+
42+
- Comment out the `@terminusdb/terminusdb-client` alias in the webpack config
43+
- Update the env file to have the `BASE_URL` be empty (also generally useful since this is where the webpack server opens the new browser window), this will mean you don't have to go to `/dashboard` as above
44+
45+
There is some additional configuration needed if you are wanting to run with Auth0 Login, essentially you just need a proxy and to setup the right auth0 config. This will allow you to login but the token generated will not be valid so you will need to replace it manually with a valid one.
3146

3247
## Publishing
3348

0 commit comments

Comments
 (0)