OS.js Manual


This guide will show you how to set up a development enviroment and to contribute changes.


You don't have to make any changes to get a development environment up and running.

Just make sure to apply the --debug flag on build tasks. You can also use the --devtool=STR webpack option to set your sourcemap of choice.

It is highly recomended that you use osjs watch to build changes as this is much faster and automatically runs whenever you make changes.

# Core
$ node osjs watch --debug

# Themes
$ node osjs watch --themes --debug

# Package
$ node osjs watch --debug --package=repo/name

If you want to use node-supervisor to automatically restart the server upon changes, use ./bin/start.sh --debug (or ./bin/win-start.cmd --debug) instead of node osjs run --debug.

You can also start the server with --reload flag. This will make server automatically reload your package server scripts upon change.

See packages manual for more information about package development.

Files, Modules and Layouts

All of the sources are located in src/ with exception of the following modules:

Brief overview over source folders:


Follow normal Github workflow:

The patch will then be reviewed and finally merged when given the OK.

The submitted changes will be analyzed and tested with various automated soultions, so to prevent errors you should follow the eslint style rules provided.

You can run node osjs test to run unit tests and eslint (node osjs mocha and node osjs eslint respectively).

Style Guide

Use two spaces for indentation, semicolons and spacing around brackets. A .eslintrc end .editorconfig is provided for you to plug into your editor or IDE of choice.