mirror of https://github.com/meshtastic/meshtastic.git synced 2024-09-19 23:57:31 -07:00

Meshtastic project website and documentation

Find a file

sigmahour 954634437f cleanup and reformatting content		2022-11-07 23:53:52 -05:00
.github	offloaded protodoc gerneration from ci to local process	2022-10-31 19:23:55 -04:00
docs	cleanup and reformatting content	2022-11-07 23:53:52 -05:00
protobufs@6b46e42a65	cleanup and reformatting content	2022-11-07 23:53:52 -05:00
scripts	revamp refinements	2022-11-03 20:10:08 -04:00
src	cleanup and reformatting content	2022-11-07 23:53:52 -05:00
static	Add mapping example	2022-11-01 23:34:37 -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	updates to various pages (#487 )	2022-11-02 09:31:54 +11: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	moved dev docs out of software page	2022-11-02 17:50:50 -04:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	Add oem tool	2022-11-02 22:25:45 +10:00
pnpm-lock.yaml	Add oem tool	2022-11-02 22:25:45 +10:00
protobuf.tmpl	fixed protobuf api links	2022-11-03 22:24:31 -04: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