mirror of https://github.com/meshtastic/meshtastic.git synced 2024-11-10 07:34:11 -08:00

Meshtastic project website and documentation

Find a file

Garth Vander Houwen a1210afc34 1.3 Config updates		2022-08-18 07:34:39 -07:00
.github	fix protobuf api docs file extension	2022-08-01 10:04:56 +10:00
docs	1.3 Config updates	2022-08-18 07:34:39 -07:00
protobufs@6bddcd2647	Update protobuf submodule	2022-08-06 11:29:39 +00:00
src	Update deps & fix typp	2022-07-31 15:32:53 +10:00
static	Update Apple file and default clients	2022-07-15 19:54:22 -07:00
.env.example	fix submodules & api url	2021-12-23 01:53:13 +11:00
.eslintrc.cjs	Hardware pages (#299 )	2022-04-02 00:34:49 +11:00
.gitignore	Remove pnpm debug	2022-06-27 07:27:19 +10:00
.gitmodules	Fix old submodule	2022-03-09 19:11:14 +11:00
.prettierrc	Hardware pages (#299 )	2022-04-02 00:34:49 +11:00
babel.config.js	Move website to repo root	2021-12-21 22:44:01 +11:00
docusaurus.config.js	fix the slugs	2022-07-03 12:22:24 -07:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	Update deps & fix typp	2022-07-31 15:32:53 +10:00
pnpm-lock.yaml	Update deps & fix typp	2022-07-31 15:32:53 +10:00
protobuf.tmpl	Move website to repo root	2021-12-21 22:44:01 +11:00
README.md	Update README.md	2022-05-13 10:12:34 +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