Meshtastic project website and documentation
Find a file
2022-05-12 13:31:35 +00:00
.github Fix CI 2022-03-09 23:39:47 +11:00
docs Add readme structure doc page 2022-05-12 22:27:15 +10:00
protobufs@f6606acbe3 Update protobuf submodule 2022-05-12 13:31:35 +00:00
src Merge pull request #331 from jfirwin/getting-started 2022-05-10 09:58:49 -06:00
static Add nano g1 and small fixes to other hardware pages 2022-05-06 21:21:34 +01:00
.env.example fix submodules & api url 2021-12-23 01:53:13 +11:00
.eslintrc.cjs Hardware pages (#299) 2022-04-02 00:34:49 +11:00
.gitignore fix/remove-inaccurate-note (#336) 2022-05-12 08:11:03 +10:00
.gitmodules Fix old submodule 2022-03-09 19:11:14 +11:00
.prettierrc Hardware pages (#299) 2022-04-02 00:34:49 +11:00
babel.config.js Move website to repo root 2021-12-21 22:44:01 +11:00
docusaurus.config.js Update dependencies 2022-05-07 23:51:02 +10:00
LICENSE Create LICENSE 2022-05-12 21:40:31 +10:00
package.json Update dependencies 2022-05-07 23:51:02 +10:00
pnpm-lock.yaml Update dependencies 2022-05-07 23:51:02 +10:00
protobuf.tmpl Move website to repo root 2021-12-21 22:44:01 +11:00
README.md Update README.md 2022-05-12 12:47:08 +10:00
sidebars.js Update docs structure 2022-04-09 00:29:34 +10:00
tailwind.config.cjs Hardware page improvements 2022-04-03 00:57:31 +11:00
tsconfig.json Update dependencies 2022-05-07 23:51:02 +10:00

Meshtastic

CI CLA assistant Fiscal Contributors Vercel

Overview

Meshtastic® is a project that lets you use inexpensive LoRa radios as a long range off-grid communicator for areas without reliable cellular service. These radios are great for hiking, skiing, paragliding - essentially any hobby where you don't have reliable internet access. Each member of the mesh can send and view text messages and enable optional GPS based location features.

The radios automatically create a mesh to forward packets as needed, so everyone in the group can receive messages from even the furthest member. The radios will optionally work with your phone, but no phone is required.

This repository contains the source for our website and documentation

Stats

Alt

Development & Building

nodejs is required in your dev. environment. The method for installing nodejs depends on your operating system. This software is built using Docusaurus.

Go to the root directory of your repository and install dependencies:

pnpm install

Build the project with the following command

pnpm build

Start a local dev. instance with the following command

pnpm start