https://github.com/virtool/virtool-ui
The browser frontend for Virtool
https://github.com/virtool/virtool-ui
frontend react virtool
Last synced: 29 days ago
JSON representation
The browser frontend for Virtool
- Host: GitHub
- URL: https://github.com/virtool/virtool-ui
- Owner: virtool
- Created: 2021-11-04T21:53:50.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2026-01-16T00:14:02.000Z (5 months ago)
- Last Synced: 2026-01-16T13:32:47.043Z (5 months ago)
- Topics: frontend, react, virtool
- Language: TypeScript
- Homepage: https://www.virtool.ca
- Size: 11.9 MB
- Stars: 4
- Watchers: 1
- Forks: 6
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# virtool-ui
The web-app frontend for Virtool
## Using in Production
The default CSP configuration expects API requests to be made to the same domain as the
client is served from. The UI server and API server should be served from behind the same
reverse proxy.
## Configuration
| Option | Env | Description |
| -------------- | ------------------ | ---------------------------------------------- |
| `-p`, `--port` | `VT_UI_PORT` | The port the UI server should listen on |
| `-H`, `--host` | `VT_UI_HOST` | The host the UI server should listen on |
| `--sentry-dsn` | `VT_UI_SENTRY_DSN` | The DSN that sentry will send logged errors to |
## Development
### Working on `virtool-ui`
Use this guide to create your environment when you are contributing to `virtool/ui`.
1. Follow the instructions in the [`dev`](https://github.com/virtool/dev) repository's README to set up a local kubernetes cluster.
2. Clone this repository onto your local machine into the same parent folder as `dev`
```
git clone https://github.com/virtool/virtool-ui.git
```
3. Start tilt with frontend editing enabled
```
tilt up -- --to-edit ui
```