mirror of
https://github.com/meshtastic/meshtastic.git
synced 2025-01-02 09:27:50 -08:00
72 lines
1.5 KiB
Plaintext
72 lines
1.5 KiB
Plaintext
---
|
|
id: web-interface
|
|
title: Web Client Development
|
|
sidebar_label: Web Client
|
|
sidebar_position: 4
|
|
---
|
|
|
|
## Overview
|
|
|
|
The Meshtastic web interface can be hosted or served from a node.
|
|
|
|
The official hosted version can be found at [https://client.meshtastic.org](https://client.meshtastic.org).
|
|
|
|
The version served from a node can be accessed by first [connecting your node to your network](/docs/settings/config/network) and then navigating to http://meshtastic.local (or your_node_ip.local).
|
|
|
|
|
|
## Development & Building
|
|
|
|
### Setup the Build Environment
|
|
|
|
[Install PlatformIO](https://platformio.org/platformio-ide)
|
|
|
|
Clone the [Meshtastic Web Repo](https://github.com/meshtastic/web) repository
|
|
```shell
|
|
git clone https://github.com/meshtastic/web.git
|
|
cd web
|
|
```
|
|
|
|
|
|
### Development
|
|
|
|
|
|
Install the dependencies.
|
|
|
|
```bash
|
|
pnpm i
|
|
```
|
|
|
|
Build the project:
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
Start the development server:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
### Packaging
|
|
|
|
Build the project:
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
GZip the output:
|
|
|
|
```bash
|
|
pnpm package
|
|
```
|
|
|
|
|
|
## Releases
|
|
|
|
Releases are automatically generated for every commit as per out [CI](https://github.com/meshtastic/web/blob/master/.github/workflows/main.yml). This performs two actions:
|
|
|
|
1. Generates a perpetually updated [GitHub release](https://github.com/meshtastic/web/releases/tag/latest) with an accompanying `build.tar` that a automatically get's pulled by the firmware CI at build time.
|
|
2. A hosted version is deployed to [client.meshtastic.org](https://client.meshtastic.org).
|