Files
lodestar/docs/install/source.md
Lion - dapplion 9e57b7d320 ci: check docs spelling (#5527)
* Check docs spelling

* Add config

* Fix docs spelling

* Lint docs format

* docs(flamegraph): remove note about script that was removed

* sort wordlist

* Set sort algo

* Fix CI pipeline

* hope to fix CI ordering

* Disable wordlist sort check

* docs(CONTRIBUTING): remove merge conflict marker and add codeblock types

* refactor: change to pyspelling.yml for local runs

* docs: make spell-checking wordlist case insensitive

* fix: sort .wordlist.txt

* refactor: alphabetize script order

* fix: add docs/reference to gitignore

* docs: add codeblocks to pyspelling ignore and clear all errors

* docs: ignore possessive endings in spellcheck

* docs: clear spelling errors in package readmes

* docs: pyspelling fix generated cli.md

* feat(workflows): lint generated docs

* feat(workflows): add word sort to docs-check

* test: unsort wordlist

* fix: sort wordlist

* refactor(workflow): remove unused comments

---------

Co-authored-by: matthewkeil <me@matthewkeil.com>
Co-authored-by: Cayman <caymannava@gmail.com>
2023-06-21 18:24:27 +00:00

1.6 KiB

Install from source

Prerequisites

Make sure to have Yarn installed. It is also recommended to install NVM (Node Version Manager) and use the LTS version (currently v18) of NodeJS.

!!! info NodeJS versions older than the current LTS are not supported by Lodestar. We recommend running the latest Node LTS. It is important to make sure the NodeJS version is not changed after reboot by setting a default nvm alias default <version> && nvm use default.

!!! note Node Version Manager (NVM) will only install NodeJS for use with the active user. If you intend on setting up Lodestar to run under another user, we recommend using NodeSource's source for NodeJS so you can install NodeJS globally.

Clone repository

Clone the repository locally and build from the stable release branch.

git clone -b stable https://github.com/chainsafe/lodestar.git

Switch to created directory.

cd lodestar

Install packages

Install across all packages. Lodestar follows a monorepo structure, so all commands below must be run in the project root.

yarn install

Build source code

Build across all packages.

yarn run build

Lodestar CLI

Lodestar should now be ready for use.

./lodestar --help

See Command Line Reference for further information.