Skip to content

Latest commit

 

History

History
48 lines (30 loc) · 1.7 KB

README.md

File metadata and controls

48 lines (30 loc) · 1.7 KB

bond-wm logo

An X Window Manager built on web technologies.

Bond Window Manager is a X window manager gives web developers a familiar platform for total customization of their desktop appearance.

The goal is to thoughtfully apply front-end technologies to the desktop. Today this means:

  • Node.js driving a window manager core, which creates desktop and frame windows using Electron and its underlying Chromium engine.
  • Vite providing first class support for TypeScript, JSX, CSS modules, and more. Vite enables "hot module replacement" for rapid iteration on desktop styling.
  • React as the primary supported UI library.

Screenshot

bond-wm screenshot

Development

This repository uses the pnpm package manager. Install pnpm >= 9.6 for your operating system.

To do prerequisite build steps:

pnpm install
pnpm build
(Equivalent to `npm run build` if you prefer npm for running scripts.)

To start a test X server (requires Xephyr):

pnpm startx

To start the window manager:

pnpm start --config ./packages/react-config

Substitute your own config package with the default one above as desired.

License

MIT License

Individual packages within the repository sometimes have different licenses.