Serving Docs Locally for Development | Meshtastic

Prerequisites

In order to set up your local environment, you will need to install:

Getting Started

Fork the Meshtastic Repository

Log into GitHub and create a fork of the meshtastic/meshtastic repository.

Clone your Meshtastic Repository fork

Clone your Fork of the Documentation Repositorygit clone https://github.com/YOUR_GITHUB_USERNAME/meshtastic.git

Change directory into your Local Copy

Change Directorycd ./meshtastic

Install Submodules

Install Submodulesgit submodule update --init --recursive

Install Dependencies

Install Node.js using NVMnvm install && nvm use
Install dependencies using pnpmpnpm i

Run Development Server

Run node.js serverpnpm start

Update Local Repository

Verify Upstream Remote is Set

Check Remote and Upstream Repositoriesgit remote -v

Update/Set Upstream if it isn't configured properly

If upstream exists, set the URL:

Update Upstream Repositorygit remote set-url upstream https://github.com/meshtastic/meshtastic.git

If upstream doesn't exist, add the URL:

Add Upstream Repositorygit remote add upstream https://github.com/meshtastic/meshtastic.git

Align with meshtastic/meshtastic Master branch

Rebase local Meshtastic to remote Meshtasticcd ~/meshtastic ; git fetch upstream ; git checkout master ; git rebase upstream/master