Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
30 changes: 30 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: WebUI CI

on:
push:
branches: ["master", "dev*", "jvm-api-v1"]
pull_request:
branches: ["master", "dev*", "jvm-api-v1"]
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: "18"
cache: npm

- name: Install dependencies
run: npm ci

- name: Type-check
run: npm run type-check

- name: Build
run: npm run build-only
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,10 @@ Visit [releases page](https://github.com/ctlab/HiCT_WebUI/releases) to obtain bi
Make [HiCT server](https://github.com/ctlab/HiCT_Server) available at `http://localhost:5000` either by starting it locally or by using port forwarding from remote server. Put HiCT files into server's data directory (you can convert Coolers using [HiCT_Utils](https://github.com/ctlab/HiCT_Utils)). Start Electron-based Web UI by unzipping binary distribution and launching `.exe` file (Windows) or by launching `.AppImage` file (linux, make sure you've made `chmod +x` for it).
Click File -> Open and select HiCT file you want to interact with. Tiles should start loading on a contact map. Use single clicks or Shift+dragging at any time to perform range selection. Click tool buttons on the left side to perform actions with selection range.
After you've done, you can either save state using File -> Save in HiCT format, or export assembly info using Assembly menu in navigation bar at the top of the window.

## API documentation integration

WebUI now links directly to backend API docs via **View → API v1 docs...**.

- Interactive Swagger UI: `http://localhost:5000/api/v1/`
- OpenAPI source: `http://localhost:5000/api/v1/openapi.yaml`
11 changes: 11 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 6 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"private": true,
"author": "Aleksandr Serdiukov, Anton Zamyatin and CT Lab ITMO University team",
"main": "dist/electron/electron/main/main.js",
"license":"MIT",
"license": "MIT",
"scripts": {
"dev": "vite",
"build": "run-p type-check build-only && tsc",
Expand All @@ -30,14 +30,17 @@
"binary-search-bounds": "2.0.5",
"bootstrap": "^5.2.2",
"bootstrap-icons": "^1.9.1",
"colortranslator": "^4.1.0",
"core-js": "^3.25.5",
"display-si": "^1.0.7",
"igv": "^2.13.3",
"jspdf": "^2.5.1",
"litegraph.js": "^0.7.18",
"mobx": "^6.6.2",
"mobx-vue-lite": "^0.3.1",
"multi-range-slider-vue": "^1.1.4",
"normalize.css": "^8.0.1",
"ol": "^9.1.0",
"display-si": "^1.0.7",
"path-browserify": "^1.0.1",
"pinia": "^2.1.6",
"primeflex": "^3.3.1",
Expand All @@ -48,9 +51,7 @@
"vanilla-picker": "^2.12.2",
"vue": "^3.2.41",
"vue-color-kit": "^1.0.6",
"vue-sonner": "^0.4.2",
"colortranslator": "^4.1.0",
"jspdf": "^2.5.1"
"vue-sonner": "^0.4.2"
},
"devDependencies": {
"@rushstack/eslint-patch": "^1.2.0",
Expand Down
Loading
Loading