You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
dependabot[bot] af2fac1465
chore(deps): bump vite from 7.1.9 to 7.1.11 (#903)
7 months ago
.githooks/_ refactor: switch to using Bun (#718) 11 months ago
.github feat(ci): add CI workflow to automatically close issue after 60 days (#897) 7 months ago
.vscode Lint tests, format JSON (#818) 9 months ago
packages chore(deps): bump vite from 7.1.9 to 7.1.11 (#903) 7 months ago
tests/utils Add transport status events (#790) 9 months ago
.gitignore Add protobufs repo as git submodule (#882) 8 months ago
.gitmodules Add protobufs repo as git submodule (#882) 8 months ago
.npmrc add npmrc to root (#696) 11 months ago
LICENSE Add npm publishing of JS libs (#702) 11 months ago
README.md Update readme with new widgets (#901) 8 months ago
biome.json Address new linting rules (#851) 9 months ago
package.json chore: update protobuf version to latest (#890) 8 months ago
pnpm-lock.yaml chore(deps): bump vite from 7.1.9 to 7.1.11 (#903) 7 months ago
pnpm-workspace.yaml Add minimumReleaseAge to pnpm-workspace.yaml (#865) 8 months ago
tsconfig.base.json feat(i18n): add fr localization support (#902) 8 months ago
tsconfig.json Lint tests, format JSON (#818) 9 months ago
vitest.config.ts Fix Docker and CI builds (#773) 10 months ago

README.md

Meshtastic Web Monorepo

CI CI CLA assistant Fiscal Contributors Vercel

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.
  • 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 Alt

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

Star History Chart

Contributors