mirror of
https://github.com/pezkuwichain/pezkuwi-telemetry.git
synced 2026-04-27 23:18:04 +00:00
Chevdor
d15409bf2e
* Exclude vscode local settings * Switch the image to nginx with ENV support * Add some doc * Fix travis config * Ignore coverage data * Remove version labels * Fix the Dockerfile according to the recent refactoring * Cleanup * Change maintainer According to @woss request * Fix travis config
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
# Polkadot Telemetry
|
|
|
|
## Getting Started
|
|
|
|
To run the backend, you will need `cargo` to build the binary. We recommend using [`rustup`](https://rustup.rs/).
|
|
|
|
To run the frontend make sure to grab the latest stable version of node and install dependencies before doing anything:
|
|
|
|
```sh
|
|
nvm install stable
|
|
yarn
|
|
```
|
|
|
|
### Terminal 1 - Backend
|
|
|
|
```
|
|
cd backend
|
|
cargo build --release
|
|
./target/release/telemetry
|
|
```
|
|
|
|
By default, telemetry will listen on the local interface only (127.0.0.1) on port 8000. You may change both those values:
|
|
|
|
Use another port:
|
|
|
|
```
|
|
PORT=8123 telemetry
|
|
```
|
|
|
|
You may also change the the listening interface. This is especially required if you are using docker:
|
|
|
|
```
|
|
BIND=0.0.0.0 telemetry
|
|
```
|
|
|
|
### Terminal 2 - Frontend
|
|
|
|
```sh
|
|
cd frontend
|
|
yarn
|
|
yarn start
|
|
```
|
|
|
|
### Terminal 3 - Node
|
|
|
|
Follow up installation instructions from the [Polkadot repo](https://github.com/paritytech/polkadot)
|
|
|
|
```sh
|
|
./target/release/polkadot --dev --telemetry-url ws://localhost:8000/submit
|
|
```
|
|
|
|
### Run via Docker
|
|
|
|
To run via docker make sure that you have Docker Desktop
|
|
- If you don't you can download for you OS here [Docker Desktop](https://www.docker.com/products/docker-desktop)
|
|
```
|
|
docker-compose up --build -d
|
|
```
|
|
- `-d` stands for detach, if you would like to see logs I recommend using [Kitmatic](https://kitematic.com/) or don't use the -d
|
|
- `--build` will build the images and rebuild, but this is not required every time
|
|
- If you want to makes UI changes, there is no need to rebuild the image as the files are being copied in via volumes.
|
|
|
|
Now navigate to localhost:3000 in your browser to view the app.
|
|
|
|
## Docker
|
|
|
|
### Build & Publish the Frontend docker image
|
|
|
|
The building process is standard. You just need to notice that the Dockerfile is in ./packages/frontend/ and tell docker about it. The context must remain the repository's root though.
|
|
|
|
```
|
|
DOCKER_USER=chevdor ./scripts/build-docker-frontend.sh
|
|
```
|