62 lines
1.7 KiB
Markdown
62 lines
1.7 KiB
Markdown
# Meshtastic Web
|
|
|
|
<!--Project specific badges here-->
|
|
|
|
[](https://github.com/meshtastic/web/actions/workflows/ci.yml)
|
|
[](https://cla-assistant.io/meshtastic/web)
|
|
[](https://opencollective.com/meshtastic/)
|
|
[](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
|
|
|
|
|
|
|
|
## Self-host
|
|
|
|
The client can be self hosted using the precompiled container images with an OCI compatible runtime such as [Docker](https://www.docker.com/) or [Podman](https://podman.io/).
|
|
The base image used is [Nginx 1.27](https://hub.docker.com/_/nginx)
|
|
|
|
```bash
|
|
# With Docker
|
|
docker run -d -p 8080:8080 --restart always --name Meshtastic-Web ghcr.io/meshtastic/web
|
|
|
|
#With Podman
|
|
podman run -d -p 8080:8080 --restart always --name Meshtastic-Web ghcr.io/meshtastic/web
|
|
```
|
|
|
|
## Development & Building
|
|
|
|
### Building and Packaging
|
|
|
|
Build the project:
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
GZip the output:
|
|
|
|
```bash
|
|
pnpm package
|
|
```
|
|
|
|
### Development
|
|
|
|
Install the dependencies.
|
|
|
|
```bash
|
|
pnpm i
|
|
```
|
|
|
|
Start the development server:
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|