mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-10 15:44:18 -08:00
42 lines
1.9 KiB
Markdown
42 lines
1.9 KiB
Markdown
# Meshtastic
|
|
|
|
<!--Project specific badges here-->
|
|
[](https://github.com/meshtastic/meshtastic/actions/workflows/ci.yml)
|
|
[](https://cla-assistant.io/meshtastic/repo)
|
|
[](https://opencollective.com/meshtastic/)
|
|
[](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)
|
|
|
|
## 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
|
|
|
|
|
|
|
|
## 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](https://docusaurus.io).
|
|
|
|
Go to the root directory of your repository and install dependencies:
|
|
|
|
```shell
|
|
pnpm install
|
|
```
|
|
|
|
Build the project with the following command
|
|
|
|
```shell
|
|
pnpm build
|
|
```
|
|
|
|
Start a local dev. instance with the following command
|
|
|
|
```shell
|
|
pnpm start
|
|
```
|