Skip to content

Cleaning up #501

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
agarny merged 3 commits into from
May 6, 2026
Merged

Cleaning up #501

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a79294c
New version.
agarny May 6, 2026
6630ba1
Updated our dependencies.
agarny May 6, 2026
c2f3b9a
Updated various docs.
agarny May 6, 2026
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
35 changes: 18 additions & 17 deletions BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,23 +48,24 @@

# Available Scripts

| Script | Description |
| --------------------- | --------------------------------------------------------------- |
| `archive:web` | Archive OpenCOR's Web app |
| `build` | Build OpenCOR |
| `build:web` | Build OpenCOR's Web app |
| `clean` | Clean OpenCOR's environment |
| `dependencies:update` | Update all dependencies to their latest versions |
| `dev` | (Build and) start OpenCOR and OpenCOR's Web app with hot reload |
| `dev:web` | (Build and) start OpenCOR's Web app with hot reload |
| `format` | Format the code |
| `format:check` | Check code formatting without making changes |
| `lint` | Lint and automatically fix issues |
| `release` | Release OpenCOR for the current platform |
| `release:local` | Release OpenCOR for the current platform without code signing |
| `start` | (Build and) start (the production version of) OpenCOR |
| `start:web` | (Build and) start (the production version of) OpenCOR's Web app |
| `version:new` | Update the version of OpenCOR |
| Script | Description |
| --------------------- | -------------------------------------------------------------------------- |
| `archive:web` | Archive OpenCOR's Web app |
| `build` | Build OpenCOR |
| `build:web` | Build OpenCOR's Web app |
| `clean` | Clean OpenCOR's environment |
| `dependencies:update` | Update all dependencies |
| `dev` | (Build and) start the development version of OpenCOR and OpenCOR's Web app |
| `dev:web` | (Build and) start the development version of OpenCOR's Web app |
| `format` | Format the code |
| `format:check` | Check code's formatting |
| `lint` | Lint and automatically fix issues |
| `release` | Release OpenCOR for the current platform |
| `release:local` | Release OpenCOR for the current platform without code signing |
| `start` | (Build and) start the production version of OpenCOR |
| `start:web` | (Build and) start the production version of OpenCOR's Web app |
| `typecheck` | Check the code for type errors |
| `version:new` | Update the version of OpenCOR |

# Notes

Expand Down
8 changes: 4 additions & 4 deletions bun.lock
View file
Open in desktop

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

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"url": "git+https://github.com/opencor/webapp.git"
},
"type": "module",
"version": "0.20260506.0",
"version": "0.20260507.0",
"engines": {
"bun": ">=1.2.0"
},
Expand Down
24 changes: 13 additions & 11 deletions src/renderer/BUILD.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,16 @@

# Available Scripts

| Script | Description |
| -------------- | ----------------------------------------------------------------|
| `build` | Build OpenCOR's Web app |
| `build:lib` | Build OpenCOR's Web app as a library |
| `clean` | Clean OpenCOR's environment |
| `dev` | (Build and) start OpenCOR's Web app with hot reload |
| `format` | Format the code using |
| `format:check` | Check code formatting without making changes |
| `lint` | Lint and automatically fix issues |
| `start` | (Build and) start (the production version of) OpenCOR's Web app |
| `version:new` | Update the version of OpenCOR |
| Script | Description |
| --------------------- | -------------------------------------------------------------- |
| `build` | Build OpenCOR's Web app |
| `build:lib` | Build OpenCOR's Web app as a library |
| `clean` | Clean OpenCOR's environment |
| `dependencies:update` | Update the package's dependencies |
| `dev` | (Build and) start the development version of OpenCOR's Web app |
| `format` | Format the code |
| `format:check` | Check the code's formatting |
| `lint` | Lint and automatically fix issues |
| `start` | (Build and) start the production version of OpenCOR's Web app |
| `typecheck` | Check the code for type errors |
| `version:new` | Update the version of OpenCOR |
8 changes: 4 additions & 4 deletions src/renderer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Some characteristics of this package are that:

The component comes with the following props:

| Name | Type | Default | Description |
| ------- | ------------------------------------------ | ---------- | -------------------------------------------------------------------------------- |
| `omex` | String | `null` | The URL of the [OMEX file](https://combinearchive.org/) to use. |
| `theme` | String: `'light'`, `'dark'`, or `'system'` | `'system'` | The theme to use. Note that it is set once and for all, i.e. it is not reactive. |
| Name | Type | Default | Description |
| ------- | ----------------------------------- | ---------- | --------------------------------------------------------------------------------------- |
| `omex` | `string` \| `Uint8Array` | `null` | The [OMEX file](https://combinearchive.org/) to use, as a URL string or raw OMEX bytes. |
| `theme` | `'light'` \| `'dark'` \| `'system'` | `'system'` | The theme to use. Note that it is set once and for all, i.e. it is not reactive. |

- **main.ts:**

Expand Down
8 changes: 4 additions & 4 deletions src/renderer/bun.lock
View file
Open in desktop

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

2 changes: 1 addition & 1 deletion src/renderer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
},
"./style.css": "./dist/opencor.css"
},
"version": "0.20260506.0",
"version": "0.20260507.0",
"scripts": {
"build": "vite build && bun scripts/generate.version.js",
"build:lib": "vite build --config vite.lib.config.ts && bunx --bun vue-tsc --project tsconfig.lib.types.json",
Expand Down
Loading