diff --git a/README.md b/README.md index 466b07c..640f9f6 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,9 @@ echo "deb [arch=amd64] https://storage.googleapis.com/bazel-apt stable jdk1.8" | sudo apt update && sudo apt install bazel ``` +#### IPFS +[Installation Guide](https://docs.ipfs.io/install/) + ### MacOS #### Docker @@ -46,6 +49,9 @@ brew install llvm protobuf python3.9 brew install bazel ``` +#### IPFS +[Installation Guide](https://docs.ipfs.io/install/) + ## Content - [`images`](images) - base docker images for [`nexus`](nexus) diff --git a/nexus/cognitron/README.md b/nexus/cognitron/README.md index 40a1de1..291cbc3 100644 --- a/nexus/cognitron/README.md +++ b/nexus/cognitron/README.md @@ -1,5 +1,9 @@ # Nexus Cognitron +## Prerequisite + +Follow the [root guide](../../README.md) to install Docker, IPFS and Bazel (optionally) + ## Guide #### 1. Download data dumps @@ -12,8 +16,8 @@ ipfs get $COLLECTION #### 2. Launch Nexus Cognitron +Create [`docker-compose.yml`](docker-compose.yml) file to set up Nexus Cognitron and then launch it: ```shell script -cd nexus/cognitron docker-compose up ``` @@ -27,6 +31,6 @@ By default this script is just printing documents. ```shell script bazel run -c opt installer -- iterate \ - --store-filepath scitech.store.tar \ + --data-filepath $COLLECTION_PATH/index/scitech \ --schema-filepath schema/scitech.yaml ``` diff --git a/nexus/cognitron/docker-compose.yml b/nexus/cognitron/docker-compose.yml index eee6ec2..0c77420 100644 --- a/nexus/cognitron/docker-compose.yml +++ b/nexus/cognitron/docker-compose.yml @@ -19,4 +19,4 @@ services: - "50000:80" volumes: - '${COLLECTION_PATH}:/summa' -version: "3.9" +version: "3" diff --git a/nexus/cognitron/installer/BUILD.bazel b/nexus/cognitron/installer/BUILD.bazel index ee8232a..1a78d5b 100644 --- a/nexus/cognitron/installer/BUILD.bazel +++ b/nexus/cognitron/installer/BUILD.bazel @@ -13,6 +13,7 @@ py_binary( deps = [ requirement("aioipfs"), requirement("fire"), + requirement("pyyaml"), requirement("tantipy"), requirement("izihawa_utils"), ], diff --git a/nexus/cognitron/web/README.md b/nexus/cognitron/web/README.md index 335fb5a..0bfba0f 100644 --- a/nexus/cognitron/web/README.md +++ b/nexus/cognitron/web/README.md @@ -1 +1,6 @@ # Nexus Web + +#### Development +```shell script +bazel run web_dev +``` \ No newline at end of file