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

rcarteraz 0a6cbe37ea trunk check autofixes for formatting errors		2023-01-19 09:53:52 +01:00
.github	Update nightly CI & remove protobufs submodule	2023-01-18 22:47:52 +10:00
.trunk	use Trunk for linting	2023-01-14 12:02:59 +10:00
.vscode	use Trunk for linting	2023-01-14 12:02:59 +10:00
docs	trunk check autofixes for formatting errors	2023-01-19 09:53:52 +01:00
src	Initial commit	2023-01-11 10:38:38 -05:00
static	adding new boards	2023-01-08 00:05:38 +01:00
.env.example	fix submodules & api url	2021-12-23 01:53:13 +11: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	rearrange and remove guides section	2023-01-13 10:18:20 +01:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	update ci & remove protobuf docs autogen	2023-01-14 14:20:47 +10:00
pnpm-lock.yaml	update ci & remove protobuf docs autogen	2023-01-14 14:20:47 +10:00
README.md	Update README.md	2023-01-02 16:46:01 +11:00
sidebars.js	update ci & remove protobuf docs autogen	2023-01-14 14:20:47 +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

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