https://github.com/ethersphere/bee-js-docs
https://github.com/ethersphere/bee-js-docs
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ethersphere/bee-js-docs
- Owner: ethersphere
- Created: 2021-01-19T16:18:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-04-28T06:31:16.000Z (17 days ago)
- Last Synced: 2025-04-28T07:32:10.429Z (17 days ago)
- Language: JavaScript
- Size: 12 MB
- Stars: 2
- Watchers: 10
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-swarm - Bee-JS Docs - Documentation for the Swarm Bee-js javascript library. View at [bee-js.ethswarm.org](https://bee-js.ethswarm.org/docs/). (Projects / Documentation)
README
# Bee JS Documentation Website
Documentation for the [Swarm Bee-js javascript library](https://github.com/ethersphere/bee-js). View at [bee-js.ethswarm.org](https://bee-js.ethswarm.org).
### Node Version
You must use **node 18** or above. We recommend [nvm](https://github.com/nvm-sh/nvm).
### Installation
```
$ npm i
```
### Local Development
```
$ npm start
```
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
### Build
```
$ npm run build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Bumping Version
Don't forget to find and replace the version number for the whole of the docs folder.
## Maintainers
See what "Maintainer" means [here](https://github.com/ethersphere/repo-maintainer).