Skip to content

Commit 9c0765d

Browse files
committed
feat: merge api
1 parent b3f521c commit 9c0765d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+218
-717
lines changed

.github/workflows/check.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ jobs:
1818

1919
env:
2020
REACT_APP_BEE_HOST: https://api.test-node.staging.ethswarm.org/
21-
REACT_APP_BEE_DEBUG_HOST: https://debug.test-node.staging.ethswarm.org/
2221

2322
steps:
2423
- uses: actions/checkout@v2
@@ -77,7 +76,7 @@ jobs:
7776
bee-url: https://unlimited.gateway.ethswarm.org
7877
token: ${{ secrets.GHA_PAT_BASIC }}
7978
error-document: index.html
80-
headers: "${{ secrets.GATEWAY_AUTHORIZATION_HEADER }}"
79+
headers: '${{ secrets.GATEWAY_AUTHORIZATION_HEADER }}'
8180

8281
- name: Upload to testnet
8382
uses: ethersphere/swarm-actions/upload-dir@v0

README.md

+24-19
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,17 @@
1313
**Warning: This project is in alpha state. There might (and most probably will) be changes in the future to its API and
1414
working. Also, no guarantees can be made about its stability, efficiency, and security at this stage.**
1515

16-
This project is intended to be used with **Bee version <!-- SUPPORTED_BEE_START -->1.12.0-88c1d236<!-- SUPPORTED_BEE_END -->**.
17-
Using it with older or newer Bee versions is not recommended and may not work. Stay up to date by joining the
18-
[official Discord](https://discord.gg/GU22h2utj6) and by keeping an eye on the
19-
[releases tab](https://github.com/ethersphere/bee-dashboard/releases).
16+
This project is intended to be used with \*\*Bee version
17+
18+
<!-- SUPPORTED_BEE_START -->1.12.0-88c1d236<!-- SUPPORTED_BEE_END -->**. Using it with older or newer Bee versions is
19+
20+
not recommended and may not work. Stay up to date by joining the [official Discord](https://discord.gg/GU22h2utj6) and
21+
by keeping an eye on the [releases tab](https://github.com/ethersphere/bee-dashboard/releases).
2022

2123
![Status page](/ui_samples/info.png)
2224

23-
| Node Setup | Upload Files | Download Content | Accounting | Settings |
24-
| ------------------------------------ | -------------------------------------- | ------------------------------------------ | ----------------------------------------- | ---------------------------------------- |
25+
| Node Setup | Upload Files | Download Content | Accounting | Settings |
26+
| ------------------------------------ | -------------------------------------- | ------------------------------------------ | ----------------------------------------- | ------------------------------------- |
2527
| ![Setup](/ui_samples/node_setup.png) | ![Upload](/ui_samples/file_upload.png) | ![Download](/ui_samples/file_download.png) | ![Accounting](/ui_samples/accounting.png) | ![Settings](/ui_samples/settings.png) |
2628

2729
## Table of Contents
@@ -45,9 +47,9 @@ npm install -g @ethersphere/bee-dashboard
4547

4648
## Usage
4749

48-
:warning: To successfully connect to the Bee node, you will need to enable the Debug API and CORS. You can do so by
49-
setting `cors-allowed-origins: ['*']` and `debug-api-enable: true` in the Bee config file and then restart the Bee node.
50-
To see where the config file is, consult the
50+
:warning: To successfully connect to the Bee node, you will need to enable CORS. You can do so by setting
51+
`cors-allowed-origins: ['*']` in the Bee config file and then restart the Bee node. To see where the config file is,
52+
consult the
5153
[official Bee documentation](https://docs.ethswarm.org/docs/working-with-bee/configuration#configuring-bee-installed-using-a-package-manager)
5254

5355
### Terminal
@@ -96,25 +98,29 @@ The Bee Dashboard runs in development mode on [http://localhost:3031/](http://lo
9698

9799
#### Environmental variables
98100

99-
The CRA supports to specify "environmental variables" during build time which are then hardcoded into the served static files.
100-
We support following variables:
101+
The CRA supports to specify "environmental variables" during build time which are then hardcoded into the served static
102+
files. We support following variables:
101103

102-
- `REACT_APP_BEE_DESKTOP_ENABLED` (`boolean`) that toggles if the Dashboard is in Desktop mode or not.
103-
- `REACT_APP_BEE_DESKTOP_URL` (`string`) defines custom URL where the Desktop API is expected. By default, it is same origin under which the Dashboard is served.
104-
- `REACT_APP_BEE_HOST` (`string`) defines custom Bee API URL to be used as default one. By default, the `http://localhost:1633` is used.
105-
- `REACT_APP_BEE_DEBUG_HOST` (`string`) defines custom Bee Debug API URL to be used as default one. By default, the `http://localhost:1635` is used.
106-
- `REACT_APP_DEFAULT_RPC_URL` (`string`) defines the default RPC provider URL. Be aware, that his only configures the default value. The user can override this in Settings, which is then persisted in local store and has priority over the value set in this env. variable. By default `https://xdai.fairdatasociety.org` is used.
104+
- `REACT_APP_BEE_DESKTOP_ENABLED` (`boolean`) that toggles if the Dashboard is in Desktop mode or not.
105+
- `REACT_APP_BEE_DESKTOP_URL` (`string`) defines custom URL where the Desktop API is expected. By default, it is same
106+
origin under which the Dashboard is served.
107+
- `REACT_APP_BEE_HOST` (`string`) defines custom Bee API URL to be used as default one. By default, the
108+
`http://localhost:1633` is used.
109+
- `REACT_APP_DEFAULT_RPC_URL` (`string`) defines the default RPC provider URL. Be aware, that his only configures the
110+
default value. The user can override this in Settings, which is then persisted in local store and has priority over
111+
the value set in this env. variable. By default `https://xdai.fairdatasociety.org` is used.
107112

108113
#### Swarm Desktop development
109114

110-
If you want to develop Bee Dashboard in the Swarm Desktop mode, then spin up `swarm-desktop` to the point where Desktop is initialized (eq. the splash screen disappear) and:
115+
If you want to develop Bee Dashboard in the Swarm Desktop mode, then spin up `swarm-desktop` to the point where Desktop
116+
is initialized (eq. the splash screen disappear) and:
111117

112118
```sh
113119
echo "REACT_APP_BEE_DESKTOP_URL=http://localhost:3054
114120
REACT_APP_BEE_DESKTOP_ENABLED=true" > .env.development.local
115121

116122
npm start
117-
npm run desktop # This will inject the API key to the Dashboard
123+
npm run desktop # This will inject the API key to the Dashboard
118124
```
119125

120126
## Contribute
@@ -136,5 +142,4 @@ See what "Maintainer" means [here](https://github.com/ethersphere/repo-maintaine
136142

137143
[BSD-3-Clause](./LICENSE)
138144

139-
140145
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fethersphere%2Fbee-dashboard.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fethersphere%2Fbee-dashboard?ref=badge_large)

0 commit comments

Comments
 (0)