add instructions on how to run
This commit is contained in:
parent
99763d9881
commit
bdbd84ab97
1 changed files with 25 additions and 1 deletions
26
README.md
26
README.md
|
|
@ -2,4 +2,28 @@
|
|||
|
||||
## Introduction
|
||||
|
||||
Use this template together with [Watt42's viewlib](https://source.c3.uber5.com/watt42-public/watt42_viewlib).
|
||||
Use this template together with [Watt42's viewlib](https://source.c3.uber5.com/watt42-public/watt42_viewlib).
|
||||
|
||||
## How to Run
|
||||
|
||||
1. Make sure you've got [poetry](https://python-poetry.org/) installed. You can
|
||||
install it by running the below (on MacOS/Linux), or [check installation
|
||||
instructions](https://python-poetry.org/docs/#installing-with-the-official-installer):
|
||||
|
||||
```bash
|
||||
curl -sSL https://install.python-poetry.org | python3 -
|
||||
```
|
||||
|
||||
2. Install dependencies using Poetry:
|
||||
|
||||
```bash
|
||||
poetry install
|
||||
```
|
||||
|
||||
3. Run the View app locally (replace `YOUR_ID` and `YOUR_TOKEN` with your actual
|
||||
Watt42 System ID and API Token):
|
||||
|
||||
```bash
|
||||
WATT42_SYSTEM_ID=YOUR_ID WATT42_API_TOKEN=YOUR_TOKEN poetry run panel serve main.py --port 5050
|
||||
```
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue