Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jtpio committed May 28, 2019
1 parent b247703 commit 46f61a1
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Voila
# Contributing to voila

## Setting up a development environment

Expand All @@ -11,25 +11,48 @@ conda activate voila
python -m pip install -e .
```

## Run voila

To start voila, run:

```bash
voila
```

or

```bash
python -m voila
```

This will open a new browser tab at [http://localhost:8866/](http://localhost:8866/).

When making changes to the frontend side of voila, open a new terminal window and run:

```bash
cd js/
npm run watch
```

Then reload the browser tab.

## Running the examples

A few additional libraries can be installed to run the example notebooks:

```bash
# to run the examples
conda install -c conda-forge ipywidgets bqplot
conda install -c conda-forge ipywidgets ipyvolume bqplot scipy
```

The examples can then be served with:

```bash
cd notebooks/
voila
```
```

## Editing templates

The default templates are located in the following folder: [share/jupyter/voila/templates/default](./share/jupyter/voila/templates/default). They are automatically picked up when running voila in development mode.

After editing the templates, reload the browser tab to see the changes.

0 comments on commit 46f61a1

Please sign in to comment.