Skip to content

Commit

Permalink
[docs]: clarify how to configure the dashboard for contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
trumbitta committed Nov 25, 2021
1 parent 8b232e3 commit 4103e71
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions components/dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ After creating a new component, run the following to update the license header:

## How to develop in gitpod.io

Edit `craco.config.js`, add `devServer` section, replace GITPOD_HOST to `SaaS Gitpod host` or `self-hosted Gitpod host`, then replace `cookie` field.
✍️ Edit `craco.config.js`:

- Add a `devServer` section:
```js
devServer: {
proxy: {
Expand All @@ -51,5 +53,9 @@ Edit `craco.config.js`, add `devServer` section, replace GITPOD_HOST to `SaaS Gi
}
}
```
- Replace `GITPOD_HOST` with *SaaS Gitpod host* (e.g. `gitpod.io`) or *self-hosted Gitpod host* (e.g. the base URL of your target self-hosted Gitpod)
- Replace `__REPLACE_YOUR_COOKIE__` with the stringified value of your auth cookie taken from your browser's dev tools while visiting your target Gitpod host (e.g. `_gitpod_io_=s%3Axxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.XXXXXXXXXXXXXXX` for `gitpod.io`).
![Where to get the auth cookie name and value from](README.png)


After following the above steps, run `yarn run start` to start developing.
🚀 After following the above steps, run `yarn run start` to start developing.
Binary file added components/dashboard/README.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4103e71

Please sign in to comment.