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: README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,25 +8,25 @@
8
8
9
9
## Background
10
10
11
-
This repo is responsible for standalone tool that lives at https://explore.ipld.io
11
+
This repo is responsible for standalone tool that lives at https://explore.ipld.io
12
12
Component code lives in a separate repo at [ipld-explorer-components](https://github.com/ipfs/ipld-explorer-components)
13
13
14
-
The app will use HTTP API via [`ipfs-http-client`](https://www.npmjs.com/package/ipfs-http-client) provided by locally running IPFS node with correct CORS headers set up, and fallback to using [js-ipfs](https://github.com/ipfs/js-ipfs) otherwise.
14
+
The ipld-explorer-components library uses [`@helia/http`](https://www.npmjs.com/package/@helia/http) to query any local IPFS node, and the network, for content. See https://github.com/ipfs/ipld-explorer-components/blob/8718cd07cd27a82fdeaa25b92c6809ba3cec489c/src/providers/helia.tsx and https://github.com/ipfs/ipld-explorer-components/blob/8718cd07cd27a82fdeaa25b92c6809ba3cec489c/src/lib/init-helia.ts#L23 for specifics.
15
15
16
-
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).
16
+
The app is built with [`Vite`](https://vitejs.dev/). Please read the [docs](https://vitejs.dev/guide/).
17
17
18
18
19
19
## Install
20
20
21
-
With `node`> 10 (but < 12) and `npm` @ 6+ installed, run
21
+
With `node` and `npm` installed, run
22
22
23
23
```js
24
24
npm install
25
25
```
26
26
27
27
## Usage
28
28
29
-
When developing you can run the [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.
29
+
When developing you can run the [dev server](https://vitejs.dev/guide/cli.html#dev), the [unit tests](https://vitest.dev/), and the [storybook](https://storybook.js.org/) component viewer and see the results of your changes as you save files.
30
30
31
31
In separate shells run the following:
32
32
@@ -36,7 +36,7 @@ npm test
36
36
```
37
37
38
38
```sh
39
-
# Run the dev server @ http://localhost:3000
39
+
# Run the dev server @ http://localhost:5173
40
40
npm start
41
41
```
42
42
@@ -71,11 +71,11 @@ The following command will run the app tests, watch source files and re-run the
71
71
npm test
72
72
```
73
73
74
-
The 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`
74
+
The app uses Vitest 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`
75
75
76
76
### Linting
77
77
78
-
The following command will perform [`standard`](https://standardjs.com/) linting on the code:
78
+
The following command will perform linting on the code using [`aegir`](https://github.com/ipfs/aegir):
0 commit comments