This is the OS.js base repository that you can use as a template to make your own distributions, installations and development environments.
This branch is for v3. The deprecated v2 codebase can be found in the
Try it yourself
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
You can run a demo using Docker without checkout out any source-code:
docker run -p 8000:8000 osjs/osjs:v3
Clone the v3 branch of the official OS.js repository:
git clone -b v3 --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:
To install directly on the host system you'll need Node 8 (or later).
# Install dependencies npm install # It's recommended that you keep your dependencies (including OS.js) up-to-date npm update # Optionally install extra packages: # For a list of packages, see https://manual.os-js.org/v3/resource/official/ npm install --production @osjs/example-application # Discover installed packages npm run package:discover # Build your client npm run build # Start serving npm run serve
See the Official Manuals for articles, tutorials and guides.