mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-26 22:19:46 -08:00

Meshtastic project website and documentation

Find a file

jopdyke 88853b1b8f Update peripherals.mdx Added US Distributor purchase link for RAK GPS modules		2023-04-26 12:11:30 -04:00
.github	Update nightly CI & remove protobufs submodule	2023-01-18 22:47:52 +10:00
.trunk	Add Trunk and lint non mdx files	2023-01-19 22:41:44 +10:00
.vscode	Add Trunk and lint non mdx files	2023-01-19 22:41:44 +10:00
docs	Update peripherals.mdx	2023-04-26 12:11:30 -04:00
src	for crying out loud...	2023-03-28 20:07:40 +02:00
static	Add Nano G1 Explorer to supported hardware.	2023-04-20 09:33:17 +10:00
.env.example	fix submodules & api url	2021-12-23 01:53:13 +11:00
.gitattributes	LF fix.	2023-01-24 09:58:28 +01:00
.gitignore	updates to various pages (#487 )	2022-11-02 09:31:54 +11:00
.gitmodules	Update nightly CI & remove protobufs submodule	2023-01-18 22:47:52 +10:00
docusaurus.config.js	Add Trunk and lint non mdx files	2023-01-19 22:41:44 +10:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	update deps	2023-04-01 14:59:45 +10:00
pnpm-lock.yaml	update deps	2023-04-01 14:59:45 +10:00
README.md	Add Trunk and lint non mdx files	2023-01-19 22:41:44 +10:00
sidebars.js	fix sidebar	2023-01-19 23:09:55 +10:00
tailwind.config.cjs	Add Trunk and lint non mdx files	2023-01-19 22:41:44 +10:00
tsconfig.json	Update dependencies	2022-05-07 23:51:02 +10:00

README.md

Meshtastic

Overview

Website and documentation source for the Meshtastic project.

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.

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