meshtastic/README.md

# Meshtastic

[![CI](https://img.shields.io/github/actions/workflow/status/meshtastic/meshtastic/ci.yml?branch=master&label=actions&logo=github&color=yellow)](https://github.com/meshtastic/meshtastic/actions/workflows/ci.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/meshtastic)](https://cla-assistant.io/meshtastic/repo)
[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)

## Overview

Website and documentation source for the Meshtastic project.

## Stats

![Alt](https://repobeats.axiom.co/api/embed/9ef7282debe009789c697432a86499ac2b058a86.svg 'Repobeats analytics image')

## 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](https://docusaurus.io).

Go to the root directory of your repository and install dependencies:

```shell
pnpm install
```

Build the project with the following command

```shell
pnpm build
```

Start a local dev. instance with the following command

```shell
pnpm start
```