Files
meshtastic-web/README.md
T
2022-05-12 21:13:56 +10:00

60 lines
1.4 KiB
Markdown

# Meshtastic Web
<!--Project specific badges here-->
[![CI](https://img.shields.io/github/workflow/status/meshtastic/meshtastic-web/CI?label=actions&logo=github&color=yellow)](https://github.com/meshtastic/meshtastic-web/actions/workflows/main.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/meshtastic-web)](https://cla-assistant.io/meshtastic/meshtastic-web)
[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
## Overview
Official [Meshtastic](https://meshtastic.org) web interface, that can be hosted or served from a node
**[Hosted version](https://client.meshtastic.org)**
## Stats
![Alt](https://repobeats.axiom.co/api/embed/1299935eef158e8156c956ba399ecda43585d86e.svg "Repobeats analytics image")
## Development & Building
### Building and Packaging
Build the project:
```bash
pnpm build
```
GZip the output:
```bash
pnpm package
```
### Development
Create a `.env` file:
```bash
cp ./.env.example ./.env
```
And define the device IP address in the `.env` file.
```
VITE_PUBLIC_DEVICE_IP=xxx.xxx.xxx.xxx
```
Install the dependencies.
```bash
pnpm i
```
Start the developtment server:
```bash
pnpm dev
```