You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/documentation/getting-started.md
+23-8Lines changed: 23 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,26 @@ import TabItem from '@theme/TabItem'
10
10
11
11
## About *bee-js*
12
12
13
-
`bee-js` simplifies development on Swarm by abstracting away many of finer details and quirks of the Bee API so that you can focus on building your dream DAPP with minimal hassle. It's the easiest way to get started developing on Swarm.
13
+
`bee-js` simplifies development on Swarm by abstracting away many of finer details and quirks of the Bee API so that you can focus on building your dream DAPP with minimal hassle.
14
14
15
-
## Installation
15
+
:::info
16
+
On this page you will learn how to install `bee-js` and connect it with your existing app or webpage.
17
+
:::
18
+
19
+
20
+
## Pre-requisites
21
+
22
+
-**A live Bee node API endpoint:**
23
+
You will need the API endpoint from a live Bee node to use `bee-js`. See the Bee docs for [node installation instructions](https://docs.ethswarm.org/docs/bee/installation/quick-start/).
24
+
-**Linux or macOS:** A Unix based operating system is preferred. Windows is supported with some small exceptions. For a smoother experience, Windows users can use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)
25
+
-**Node.js (v18 or higher)** - [Get Node.js](https://nodejs.org/)
Node.js and npm are not required if you choose to import `bee-js` directly as a script from [unpkg.com](https://unpkg.com/@ethersphere/bee-js/dist/index.browser.min.js).
After that you need to import the `Bee` class and initialize an instance of it using our Bee node's API endpoint (here we assume it runs on localhost on the default port).
65
+
### Node.js (npm or yarn)
49
66
50
-
:::info Run your own Bee node
51
-
You can find out more about setting up a Bee node and getting your node's API endpoint in the [Bee docs](https://docs.ethswarm.org/docs/installation/quick-start)
52
-
:::
67
+
After that you need to import the `Bee` class and initialize an instance of it using our Bee node's API endpoint (here we assume it runs on localhost on the default port).
53
68
54
69
```js
55
70
import { Bee } from"@ethersphere/bee-js"
@@ -59,7 +74,7 @@ const bee = new Bee('http://localhost:1633')
59
74
60
75
That’s it! now you can use the `bee` object.
61
76
62
-
:::tip Using `<script>` import
77
+
### Script Tag
63
78
64
79
If you include `bee-js` using the `unpkg.com` script link then all the exported components will be available to you
0 commit comments