mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-25 05:34:11 -08:00

Meshtastic project website and documentation

Find a file

sigmahour aee0d94bae getting started updates (#481 ) Co-authored-by: sigmahour <>		2022-11-01 19:44:02 +11:00
.github	offloaded protodoc gerneration from ci to local process	2022-10-31 19:23:55 -04:00
docs	getting started updates (#481 )	2022-11-01 19:44:02 +11:00
protobufs@ed9f2499d6	offloaded protodoc gerneration from ci to local process	2022-10-31 19:23:55 -04:00
scripts	offloaded protodoc gerneration from ci to local process	2022-10-31 19:23:55 -04:00
src	offloaded protodoc gerneration from ci to local process	2022-10-31 19:23:55 -04:00
static	Add files via upload	2022-10-31 21:31:55 -04:00
.env.example	fix submodules & api url	2021-12-23 01:53:13 +11:00
.eslintrc	add eslint config	2022-09-21 19:33:07 +10:00
.gitignore	Remove pnpm debug	2022-06-27 07:27:19 +10:00
.gitmodules	Repo updates	2022-10-31 18:31:16 +10:00
.prettierrc	Hardware pages (#299 )	2022-04-02 00:34:49 +11:00
docusaurus.config.js	Update config and design repo	2022-10-31 19:17:46 +10:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	bump deps	2022-10-31 17:06:53 +10:00
pnpm-lock.yaml	bump deps	2022-10-31 17:06:53 +10:00
protobuf.tmpl	Move website to repo root	2021-12-21 22:44:01 +11:00
README.md	Update repobeats link & repo url's	2022-10-31 18:53:15 +10:00
sidebars.js	Developers, Developers, Developers	2022-06-30 08:48:30 -07: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