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
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,17 @@
1
1
# Orcfax Archive Viewer
2
2
3
-
Orcfax Archive Viewer is a Svelte app that compiles everything needed to explore a single Orcfax Fact Statement archive from Arweave into a single static `index.html` file that is intended to be used locally and offline.
3
+
Orcfax Archive Viewer is a Svelte app that compiles everything needed to explore
4
+
a single Orcfax Fact Statement archive from Arweave into a single static
5
+
`index.html` file that is intended to be used locally and offline.
4
6
5
-
The compiled static `index.html` file is packaged along with the [Orcfax Explorer](https://github.com/orcfax/explorer.orcfax.io) as a static asset so that it can be downloaded and packaged along with a full Fact Statement archive folder which is fetched from Arweave.
7
+
The compiled static `index.html` file is packaged along with the
8
+
[Orcfax Explorer](https://github.com/orcfax/explorer.orcfax.io) as a static
9
+
asset so that it can be downloaded and packaged along with a full Fact Statement
10
+
archive folder which is fetched from Arweave.
6
11
7
-
The viewer does not access the folder of archived files directly, instead, on download from the Explorer, a JSON representation of the archive's contents are injected into a global window variable so it can be used internally.
12
+
The viewer does not access the folder of archived files directly, instead, on
13
+
download from the Explorer, a JSON representation of the archive's contents are
14
+
injected into a global window variable so it can be used internally.
8
15
9
16
An example JSON file is included in the repo for local development purposes.
10
17
@@ -20,9 +27,14 @@ pnpm i
20
27
21
28
## Building
22
29
23
-
To run the viewer with local test data, copy the contents of `example-archive.json` and paste it in place of `'DATA_PLACEHOLDER'` (NB. replace the single-quotation marks as well) at the bottom of `/index.html` located at the root of this repository.
30
+
To run the viewer with local test data, copy the contents of
31
+
`example-archive.json` and paste it in place of `'DATA_PLACEHOLDER'` (NB.
32
+
replace the single-quotation marks as well) at the bottom of `/index.html`
33
+
located at the root of this repository.
24
34
25
-
Once you have replaced the `'DATA_PLACEHOLDER'` (including quotes) it is recommended to run formatting and linting first. This will prettify the source data.
35
+
Once you have replaced the `'DATA_PLACEHOLDER'` (including quotes) it is
36
+
recommended to run formatting and linting first. This will prettify the source
37
+
data.
26
38
27
39
```bash
28
40
pnpm run format
@@ -45,4 +57,6 @@ Start a development server with:
45
57
pnpm run dev
46
58
```
47
59
48
-
The local archive will be visible at the server location and port on your localhost, e.g. `http://<localhost-ip>:<port>/`. Alternatively, open the `build/index.html` file in your choice of web-browser.
60
+
The local archive will be visible at the server location and port on your
61
+
localhost, e.g. `http://<localhost-ip>:<port>/`. Alternatively, open the
62
+
`build/index.html` file in your choice of web-browser.
0 commit comments