Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ether1project/ethofs-webui-core
https://github.com/ether1project/ethofs-webui-core
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/ether1project/ethofs-webui-core
- Owner: Ether1Project
- License: mit
- Created: 2019-07-09T13:32:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-15T17:16:51.000Z (about 4 years ago)
- Last Synced: 2024-04-11T13:41:00.028Z (9 months ago)
- Language: JavaScript
- Size: 15 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IPFS Web UI
> A web interface to [IPFS](https://ipfs.io).
>
> Check on your node stats, explore the IPLD powered merkle forest, see peers around the world and manage your files, without needing to touch the CLI.
| Files | Explore | Peers | Settings |
|-------|---------|-------|----------|
|  |  |  |  |
[](https://protocol.ai/) [](http://webchat.freenode.net/?channels=%23ipfs) [](https://david-dm.org/ipfs-shipyard/ipfs-webui/revamp) [](https://circleci.com/gh/ipfs-shipyard/ipfs-webui)
The IPFS WebUI is a **work-in-progress**. Help us make it better! We use the issues on this repo to track the work and it's part of the wider [IPFS GUI project](https://github.com/ipfs/ipfs-gui).
The app uses [`ipfs-http-client`](https://github.com/ipfs/js-ipfs-http-client) to communicate with your local IPFS node.
The app is built with [`create-react-app`](https://github.com/facebook/create-react-app). Please read the [docs](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#table-of-contents).
## Install
With `node` >= 8.12 and `npm` >= 6.4.1 installed, run
```sh
> npm install
```
## Usage
**When working on the code**, run an ipfs daemon, the local [dev server](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-start), the [unit tests](https://facebook.github.io/jest/), and the [storybook](https://storybook.js.org/) component viewer and see the results of your changes as you save files.
In separate shells run the following:
```sh
# Run IPFS
> ipfs daemon
```
```sh
# Run the dev server @ http://localhost:3000
> npm start
```
```sh
# Run the unit tests
> npm test
```
```sh
# Run the UI component viewer @ http://localhost:9009
> npm run storybook
```
### Configure IPFS API CORS headers
You must configure your IPFS API at http://127.0.0.1:5001 to allow [cross-origin (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) requests from your dev server at http://localhost:3000
Similarly if you want to try out pre-release versions at https://webui.ipfs.io you need to add that as an allowed domain too.
#### Easy mode
Run the **[cors-config.sh](./cors-config.sh)** script with:
```console
> ./cors-config.sh
```
#### The manual way
```console
> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["http://localhost:3000", "https://webui.ipfs.io"]'
> ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST"]'
```
#### Reverting
To reset your config back to the default configuration, run the following command.
```console
> ipfs config --json API.HTTPHeaders {}
```
You might also like to copy the `~/.ipfs/config` file somewhere with a useful name so you can use `ipfs config replace ` to switch your node between default and dev mode easily.
## Build
To create an optimized static build of the app, output to the `build` directory:
```sh
# Build out the html, css & jss to ./build
> npm run build
```
## Test
The following command will run the app tests, watch source files and re-run the tests when changes are made:
```sh
> npm test
```
The WebUI uses Jest to run the isolated unit tests. Unit test files are located next to the component they test and have the same file name, but with the extension `.test.js`
## End-to-end tests
The end-to-end tests (e2e) test the full app in a headless Chromium browser. They require an http server to be running to serve the app.
In dev, run `npm start` in another shell before starting the tests
```
# Run the end-to-end tests
> npm run test:e2e
```
By default the test run headless, so you won't see the the browser. To debug test errors, it can be helpful to see the robot clicking around the site. To disable headless mode and see the browser, set the environment variable `DEBUG=true`
```
# See the end-to-end tests in a browser
> DEBUG=true npm run test:e2e
```
In a **continuous integration** environment we lint the code, run the unit tests, build the app, start an http server and run the unit e2e tests.
```sh
> npm run lint
> npm test
> npm run build
> npm run test:ci:e2e
```
## Coverage
To do a single run of the tests and generate a coverage report, run the following:
```sh
> npm run test:coverage
```
## Lint
Perform [`standard`](https://standardjs.com/) linting on the code:
```sh
> npm run lint
```
## Analyze
To inspect the built bundle for bundled modules and their size, first `build` the app then:
```sh
# Run bundle
> npm run analyze
```
## Translations
The translations are stored on [./public/locales](./public/locales) and the English version is the source of truth. We use Transifex to help us translate WebUI to another languages.
**If you're interested in contributing a translation**, go to [our page on Transifex](https://www.transifex.com/ipfs/ipfs-webui/translate/), create an account, pick a language and start translating.
You can read more on how we use Transifex and i18next in this app at [`docs/LOCALIZATION.md`](docs/LOCALIZATION.md)
## Releasing a new version of the WebUI.
1. PR master with the result of `tx pull -a` to pull the latest translations from transifex
1. Tag it `npm version`, `git push`, `git push --tags`.
1. Add release notes to https://github.com/ipfs-shipyard/ipfs-webui/releases
1. Wait for master to [build on CI](https://circleci.com/gh/ipfs-shipyard/ipfs-webui), and grab the CID for the build
1. Update the hash at:
- js-ipfs https://github.com/ipfs/js-ipfs/blob/master/src/http/api/routes/webui.js#L20
- go-ipfs https://github.com/ipfs/go-ipfs/blob/master/core/corehttp/webui.go#L4
- companion https://github.com/ipfs-shipyard/ipfs-companion/blob/master/add-on/src/lib/state.js#L27
- desktop https://github.com/ipfs-shipyard/ipfs-desktop/blob/master/package.json#L17
## Contribute
Feel free to dive in! [Open an issue](https://github.com/ipfs-shipyard/ipfs-webui/issues/new) or submit PRs.
To contribute to IPFS in general, see the [contributing guide](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md).
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
## License
[MIT](LICENSE) © Protocol Labs