Meshtastic Web Monorepo

Overview

This monorepo consolidates the official Meshtastic web interface and its supporting JavaScript libraries. It aims to provide a unified development experience for interacting with Meshtastic devices.

Note

You can find the main Meshtastic documentation at https://meshtastic.org/docs/introduction/.

Projects within this Monorepo (packages/)

All projects are located within the packages/ directory:

• packages/web (Meshtastic Web Client): The official web interface, designed to be hosted or served directly from a Meshtastic node.
  • Hosted version
• packages/core: Core functionality for Meshtastic JS.
• packages/transport-node: TCP Transport for the NodeJS runtime.
• packages/transport-node-serial: NodeJS Serial Transport for the NodeJS runtime.
• packages/transport-deno: TCP Transport for the Deno runtime.
• packages/transport-http: HTTP Transport.
• packages/transport-web-bluetooth: Web Bluetooth Transport.
• packages/transport-web-serial: Web Serial Transport.
• packages/protobufs: Git submodule containing Meshtastic’s shared protobuf definitions, used to generate and publish the JSR protobuf package.

All Meshtastic JS packages (core and transports) are published both to JSR. NPM

---

Repository activity

Project	Repobeats
Meshtastic Web

---

Tech Stack

This monorepo leverages the following technologies:

• Runtime: pnpm / Deno
• Web Client: React.js
• Styling: Tailwind CSS
• Bundling: Vite
• Language: TypeScript
• Testing: Vitest, React Testing Library

---

Getting Started

Prerequisites

You'll need to have pnpm installed to work with this monorepo. Follow the installation instructions on their home page.

Development Setup

1. Clone the repository:

   git clone https://github.com/meshtastic/meshtastic-web.git
   cd meshtastic-web

2. Install dependencies for all packages:

   pnpm install

   This command installs all necessary dependencies for all packages within the monorepo.

Running Projects

Meshtastic Web Client

Please refer to the Meshtastic Web README for setup and usage.

Feedback

If you encounter any issues, please report them in our issues tracker. Your feedback helps improve the stability of future releases

Star history

Contributors