Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/os-js/OS.js

OS.js - JavaScript Web Desktop Platform
https://github.com/os-js/OS.js

cloud-platform desktop javascript osjs web-desktop

Last synced: 26 days ago
JSON representation

OS.js - JavaScript Web Desktop Platform

Lists

README 

        


  OS.js Logo




# OS.js



[OS.js](https://www.os-js.org/) is an [open-source](https://raw.githubusercontent.com/os-js/OS.js/master/LICENSE) web desktop platform with a window manager, application APIs, GUI toolkit, filesystem abstractions and much more.



**Backing/Donations:**

[Github sponsorship](https://github.com/sponsors/andersevenrud),

[Patreon](https://www.patreon.com/user?u=2978551&ty=h&u=2978551),

[OpenCollective](https://opencollective.com/osjs),

[LibrePay](https://liberapay.com/os-js/),

[PayPal](https://paypal.me/andersevenrud),

[Bitcoin](https://manual.os-js.org/wallet.png)



**Support:**

[Chat](https://gitter.im/os-js/OS.js),

[Forums](https://community.os-js.org/),

[Twitter](https://twitter.com/osjsorg),

[Facebook](https://www.facebook.com/os.js.org)



## Introduction



This is the OS.js base repository that you can use as a template to make your own distributions, installations and development environments.



## Try it yourself



Visit the [official demo](https://demo.os-js.org/) for a preview version. Please note that some features are disabled and might be outdated or unavailable at times.



![ScreenShot](https://www.os-js.org/screenshot.png)



## Documentation



See the [official manuals](https://manual.os-js.org/) for articles, tutorials and guides.



There's also a [contribution guide](https://github.com/os-js/OS.js/blob/master/CONTRIBUTING.md) if you want to contribute to this project.



## Installation



> OS.js runs on `http://localhost:8000` by default.



### Using a pre-made image



You can use the official Docker base image to run OS.js without downloading this repository.



This image is based on this source code and comes with a minimal setup.



```bash

docker run -p 8000:8000 osjs/osjs:latest

```



### Using this repository



Clone the master branch:



> You can also download an archived version (ex. zip file) instead of using git.



```bash

git clone -b master --single-branch https://github.com/os-js/OS.js.git

cd OS.js

```



#### Docker Compose installation



The easiest way to install is to use Docker Compose. This allows you to run a single command

to set everything up:



```bash

docker-compose up

```



#### Local installation



You can also install this directly onto your system by using the following set of commands.



> **NOTE:** Requires Node v10 (or later. **[node 17 not currently supported without workaround](https://github.com/os-js/OS.js/issues/785)**).



```bash

# 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/resource/official/

npm install @osjs/example-application



# Discover installed packages

npm run package:discover



# Build client

npm run build



# Start serving

npm run serve

```