Skip to content

Scaratech/XenOS

Repository files navigation

A WebOS with the best UI to date

What is XenOS?

XenOS is a highly customizable "WebOS" with a ton of features and a sleek UI. You can view a live demo at: https://xen-os.dev/

Screenshot Screenshot 2

Developing XenOS

Dependencies

  • NodeJS
  • NPM (PNPM is strongly recommended)
  • Git
  • uuidgen

Currently XenOS supports building on Windows, but we cannot promise compatibility forever. We recommended using WSL

Instructions

First, clone the repo

$ git clone https://github.com/scaratech/xenos.git --recursive
$ cd xenos

Install dependencies

pnpm i # Or npm i

To start the dev server

# If you are on Linux, MacOS, or some other UNIX-like OS:
pnpm dev # or npm run build

# If you are on Windows, or are just a weirdo who enjoys Powershell
pnpm dev:windows # or npm run build:windows

To build

# Same spiel as above
pnpm build
pnpm build:windows

To serve the build

pnpm start # or npm start

Documentation

  • Documentation related to APIs can be found at https://docs.xen-os.dev
    • This is an automatically generated TypeDoc build (at src/, so it includes ALL the XenOS code), you'll probably want see this for a good API overview with JSDoc annotation
  • Other documentation can be found here

Whats Left?

You can view the projects TODO here

I Found a Bug!!!!

First check here to see if the bug is already known or check existing GitHub issues, if not, then report it! (Using GitHub issues)

Changelog

The changelog can be found here

Contributors

  • Scaratek - Lead developer
  • Madjik - Various UI tweaks and logo designer

Contributions are very much welcome!! Even if it's just fixing my spelling :)

Credit

Dependencies Used

There are more dependencies used that are not listed here, for a full list, check the package.json

What Framework Do You Use?!?

None! Just TypeScript and CSS :)

Source Code License

XenOS is licensed under the AGPLv3 License