1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
# Contributing to Lumino
Lumino is a subproject of Project Jupyter and subject to the [Jupyter governance](https://github.com/jupyter/governance) and [Code of conduct](https://github.com/jupyter/governance/blob/master/conduct/code_of_conduct.md).
## General Guidelines
For general documentation about contributing to Jupyter projects, see the [Project Jupyter Contributor Documentation](https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html).
## Setting up a development environment
Lumino requires [nodejs](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/lang/en/) for local development. After
cloning Lumino, run the following to install dependencies and build the source:
```bash
yarn
yarn build:src
```
## Tests
The tests are written using karma to simulate a browser environment.
To run the tests, run:
```bash
yarn build:test
yarn test # optionally test:chrome, test:firefox, or test:ie
```
## Examples
Lumino examples are in the `examples/` folder. To build and run an example:
```bash
yarn build:examples
cd example/dockpanel
```
Open the `index.html` file in a browser to see the running example.
|
