Skip to content

[dashboard] add develop guide #6036

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2021
Merged

[dashboard] add develop guide #6036

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 22 additions & 1 deletion components/dashboard/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,25 @@ const GitIntegration = React.lazy(() => import('./settings/GitIntegration'));
Global state is passed through `React.Context`.

After creating a new component, run the following to update the license header:
`leeway run components:update-license-header`
`leeway run components:update-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.
```js
devServer: {
proxy: {
'/api': {
target: 'https://' + GITPOD_HOST,
ws: true,
headers: {
host: GITPOD_HOST,
origin: 'https://' + GITPOD_HOST,
cookie: '__REPLACE_YOUR_COOKIE__'
},
}
}
}
```

After following the above steps, run `yarn run start` to start developing.