mirror of
https://github.com/ChainSafe/lodestar.git
synced 2026-01-09 15:48:08 -05:00
9e57b7d320
* 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>
2.4 KiB
2.4 KiB
Welcome to the Lodestar documentation!
Lodestar is an open-source Ethereum Consensus client and Typescript ecosystem, maintained by ChainSafe Systems
Getting started
- Follow the installation method for source install, NPM install, or Docker install to install Lodestar. Or use our Lodestar Quickstart scripts.
- Use Lodestar libraries in your next Ethereum Typescript project.
- Run a beacon node on mainnet or a public testnet.
- Utilize the whole stack by starting a local testnet.
- View the Lodestar CLI commands and options
- Prospective contributors can read the contributing section to understand how we develop and test on Lodestar.
- If you have questions submit an issue or join us on Discord!
- Please note our security policy.
- Sign up to our mailing list for announcements and any critical information about Lodestar.
Specifications
Hardware specifications minimum / recommended, to run the Lodestar client.
| Minimum | Recommended | |
|---|---|---|
| Processor | Intel Core i5–760 or AMD FX-8100 | Intel Core i7–4770 or AMD FX-8310 |
| Memory | 4GB RAM | 8GB RAM |
| Storage | 20GB available space SSD | 100GB available space SSD |
| Internet | Broadband connection | Broadband connection |
About these docs
This documentation is open source, contribute at Github Lodestar repository /docs.
Need assistance?
If you have questions about this documentation, feel free to talk to us on our ChainSafe Discord or open an issue and a member of the team or our community will be happy to assist you.