Repository files navigation

Documentation for theSwarm Bee Client. View atdocs.ethswarm.org.

Pull Requests are welcome, but please read ourCODING guide!

You must usenode 18 or above. We recommendnvm.

After the initial cloning of the repo you need to run:

npm ci

to download the exact revisions of the dependencies captured inpackage-lock.json.

If the dependencies are updated inpackage.json, or if you wish totest with the latest revisions of the dependencies, then you shouldrun:

npm install

and then consider pushing the updatedpackage-lock.json to therepository if everything works fine.

npm start

This command starts a local development server and opens up a browserwindow. Most changes are reflected live without having to restart theserver.

npm run build

This command generates static content into thebuild directory and can be served using any static contents hosting service.

The lunr search plugin relies on manualswizzling, which ejects the SearchBar component from the theme to allow for customization. Upgrading the Docusaurus theme WILL NOT upgrade swizzled components. This means upgrading the theme could break the search bare. Therefore whenever you upgrade the theme, make sure to delete the old swizzleed SearchBar component at src/theme/SearchBar and swizzle it again using this command:

npm run swizzle docusaurus-lunr-search SearchBar -- --eject --danger

See the documentation for the above command and the plugin at its github repohere.

Don't forget to find and replace the version number for the whole of the docs folder.

The OpenAPI reference docs are compiled at build time from the OpenAPI yaml files in the/openapi directory using theredocusaurus plugin for Docusaurus. They must be manually updated to stay up to date with theOpenAPI specs in the Bee repo.