Meshtastic project website and documentation
Find a file
2022-03-09 15:57:05 -03:00
.github Fix CI 2022-03-09 23:39:47 +11:00
docs Merge branch 'meshtastic:master' into master 2022-03-09 15:57:05 -03:00
protobufs@e9587a5508 Update protobuf submodule 2022-03-09 12:25:05 +00:00
src Simplify build instrucions and rename plugins. 2022-03-09 18:10:41 +11:00
static Merge branch 'meshtastic:master' into master 2022-03-09 10:11:53 -03:00
.env.example fix submodules & api url 2021-12-23 01:53:13 +11:00
.gitignore Add prisma DB model 2021-12-21 22:28:51 +11:00
.gitmodules Fix old submodule 2022-03-09 19:11:14 +11:00
babel.config.js Move website to repo root 2021-12-21 22:44:01 +11:00
docusaurus.config.js Merge branch 'clean-getting-started' of https://github.com/jfirwin/Meshtastic into jfirwin-clean-getting-started 2022-03-08 12:39:27 +11:00
package.json Fix build, move to pnpm & ci update 2022-03-09 23:10:04 +11:00
pnpm-lock.yaml Fix build, move to pnpm & ci update 2022-03-09 23:10:04 +11:00
protobuf.tmpl Move website to repo root 2021-12-21 22:44:01 +11:00
README.md Consolidate asset folders 2022-03-08 22:49:40 +11:00
sidebars.js Merge branch 'meshtastic:master' into master 2022-03-09 15:57:05 -03:00
tsconfig.json General cleanup and docsearch migration 2022-03-07 23:43:03 +11:00

Meshtastic

Website   •   Forum   •   Discord   •   App

What is Meshtastic?

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.

Meshtastic uses LoRa for the long range communications and depending on settings used, the maximum theoretical group size ranges from 30-200 device nodes. Currently each device can only support a connection from a single user at a time.

Please see our website for more information about Meshtastic.

Powered by Vercel

Installation

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

Fork then clone the repository:

git clone https://github.com/meshtastic/meshtastic

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

yarn install

Build the project with the following command

yarn build

Start a local dev. instance with the following command

yarn start