bmm-web

This repository will be used for a new website for https://bmm.bcc.media using Nuxt 3. In a later stage we want to use the same code to create a desktop app.

This repository uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Develop

pnpm i

Website

pnpm dev

App

pnpm dev:electron

Note: If you had an error in your code and the system still shows you the error but you've already fixed it, consider running pnpm clean. If you have this problem often, consider contacting one of the maintainers of the project.

Build

To build, first install all packages

pnpm i

You may have to install pnpm first:

npm -g i pnpm

Website

pnpm build

App

pnpm build:electron
pnpm package:electron

Note: Target package:electron will by default only build an app for the current platform and current architecture. If you want to go beyond, please visit https://www.electron.build/multi-platform-build.html.

Note: Electron registers a handler for the url-scheme bmm on start, which means that after starting the electron-app in dev-mode or a new build, the system will always use this instance for opening links with the scheme bmm. This might be desirable while testing. Keep in mind to start your installed version of the bmm-electron app when you're done, so it can re-register as handler of the bmm scheme and deep-links will open with the installed version of the app.

E2E testing

Prepare by having a version of this project running. You may use pnpm preview to run the tests against a build locally or pnpm dev. The command pnpm e2e will start an interactive version of cypress.

You may create the file cypress.env.json to set e.g. the username and password used for testing.

Recommended IDE Setup

• VS Code + Plugins and configuration provided by .vscode/extensions.json and .vscode/settings.json

Type Support For .vue Imports in TS

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

Creating a new electron build

Please see the Electron documentation on the GitHub Release Workflow.

• The new release in Github should be called the same as version in package.json (e.g. 0.0.5)
• The tag of the release should be 'v0.0.5' and 'Create new tag: v0.0.5 on publish' needs to be set
• Save Release as draft

That way every new build will update the binaries of the release above. Once the version is ready, it will create the correct tag in git.