@youwol/platform

OS like frontend application of YouWol platform.

This library is part of the hybrid cloud/local ecosystem YouWol.

Links

Running app.

Online user-guide

Developers documentation

Package on npm

Source on GitHub

Installation, Build, Test

To install the required dependencies:

yarn

---

To build for development:

yarn build:dev

To build for production:

yarn build:prod

---

To run tests:

yarn test

Coverage can be evaluated using:

yarn test-coverage

---

To start the 'dev-server':

yarn start

In order to use the dev-server within Py-YouWol and to serve resources in place of the usual CDN database, the Py-YouWol configuration needs to be updated to include a WebpackDevServerSwitch within a FlowSwitcherMiddleware. For example:

from youwol.app.environment import *
from youwol.pipelines.pipeline_typescript_weback_npm import WebpackDevServerSwitch

Configuration(
    customization = Customization(
        middlewares = [
            FlowSwitcherMiddleware(
                name = 'front-end dev-servers',
                oneOf = [
                    WebpackDevServerSwitch(packageName="@youwol/platform", port=3004),
                ]
            )
        ]
    )
)

Additional information on the Configuration class can be found in the "Configuration API" page of the Py-YouWol guide.

Once Py-YouWol is running with the updated configuration, the application can be accessed from here (providing py-youwol running using the default port 2000).

---

To generate code's documentation:

yarn doc