OS.js is an open-source web desktop platform with a window manager, application APIs, GUI toolkit, filesystem abstractions and much more.
This is the OS.js base repository that you can use as a template to make your own distributions, installations and development environments.
Visit the official demo for a preview version. Please note that some features are disabled and might be outdated or unavailable at times.
OS.js runs on
http://localhost:8000by default.
You can run a demo using Docker without checking out any source-code:
docker run -p 8000:8000 osjs/osjs:latest
Clone the master branch of the official OS.js repository:
git clone -b master --single-branch https://github.com/os-js/OS.js.git
cd OS.js
You can run OS.js locally without installing anything on your host system if you have Docker and Docker Compose installed.
Simply run the following command and a complete environment will be set up for you:
docker-compose up
To install directly on the host system you'll need Node 10 (or later).
# Install dependencies
npm install
# It's recommended that you update dependencies
npm update
# Optionally install extra packages:
# For a list of packages, see https://manual.os-js.org/v3/resource/official/
npm install @osjs/example-application
# Discover installed packages
npm run package:discover
# Build client
npm run build
# Start serving
npm run serve
- Sponsor on Github
- Become a Patreon
- Support on Open Collective
- Contribution Guide
See the Official Manuals for articles, tutorials and guides.