Skip to content

Commit

Permalink
docs: add environment and dev install sections (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
mariobuikhuizen authored Feb 10, 2022
1 parent 9840e57 commit 66f2673
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,23 @@ any other widget.
Example
-------

Make an environment:
```
$ conda create -n vev -c conda-forge voila bqplot ipyvuetify nodejs=14
$ conda activate vev
(vev) $ pip install voila-embed
(vev) $ npm install -g yarn
```

In the example directory run:
```
$ voila --no-browser --template=embed --enable_nbextensions=True --Voila.tornado_settings="{'allow_origin': 'http://localhost:8080', 'allow_credentials': True}" --port=8000
(vev) $ voila --no-browser --template=embed --enable_nbextensions=True --Voila.tornado_settings="{'allow_origin': 'http://localhost:8080', 'allow_credentials': True}" --port=8000
```

In another terminal in the example directory run:
```
$ yarn
$ yarn serve
(vev) $ yarn
(vev) $ yarn serve
```

The example site is now available on http://localhost:8080
Expand Down Expand Up @@ -96,3 +104,11 @@ module.exports = {
]
}
```

Dev install
-----------

Run the example normally, then from the main directory copy after a change:
```
$ cp -r src package.json example/node_modules/voila-embed-vuetify
```

0 comments on commit 66f2673

Please sign in to comment.