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

Garth Vander Houwen f31ed9f93f Merge pull request #454 from charlesmarseille/patch-2 Update remote-admin.mdx		2022-10-27 06:02:31 -07:00
.github	fix protobuf api docs file extension	2022-08-01 10:04:56 +10:00
docs	Merge branch 'master' into patch-2	2022-10-27 05:52:39 -07:00
protobufs@a72983993c	launch page scaffolding	2022-10-15 17:36:24 +11:00
src	launch page scaffolding	2022-10-15 17:36:24 +11:00
static	Delete Thumbs.db	2022-10-22 11:39:26 -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	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	Update docusaurus.config.js	2022-10-05 16:43:57 -05:00
LICENSE	Create LICENSE	2022-05-12 21:40:31 +10:00
package.json	launch page scaffolding	2022-10-15 17:36:24 +11:00
pnpm-lock.yaml	launch page scaffolding	2022-10-15 17:36:24 +11: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