Merge pull request #11 from the-superpirate/master

fix: Fix documentation
This commit is contained in:
the-superpirate 2021-01-29 12:12:24 +03:00 committed by GitHub
commit 5867e35635
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 19 additions and 3 deletions

View File

@ -30,6 +30,9 @@ echo "deb [arch=amd64] https://storage.googleapis.com/bazel-apt stable jdk1.8" |
sudo apt update && sudo apt install bazel sudo apt update && sudo apt install bazel
``` ```
#### IPFS
[Installation Guide](https://docs.ipfs.io/install/)
### MacOS ### MacOS
#### Docker #### Docker
@ -46,6 +49,9 @@ brew install llvm protobuf python3.9
brew install bazel brew install bazel
``` ```
#### IPFS
[Installation Guide](https://docs.ipfs.io/install/)
## Content ## Content
- [`images`](images) - base docker images for [`nexus`](nexus) - [`images`](images) - base docker images for [`nexus`](nexus)

View File

@ -1,5 +1,9 @@
# Nexus Cognitron # Nexus Cognitron
## Prerequisite
Follow the [root guide](../../README.md) to install Docker, IPFS and Bazel (optionally)
## Guide ## Guide
#### 1. Download data dumps #### 1. Download data dumps
@ -12,8 +16,8 @@ ipfs get $COLLECTION
#### 2. Launch Nexus Cognitron #### 2. Launch Nexus Cognitron
Create [`docker-compose.yml`](docker-compose.yml) file to set up Nexus Cognitron and then launch it:
```shell script ```shell script
cd nexus/cognitron
docker-compose up docker-compose up
``` ```
@ -27,6 +31,6 @@ By default this script is just printing documents.
```shell script ```shell script
bazel run -c opt installer -- iterate \ bazel run -c opt installer -- iterate \
--store-filepath scitech.store.tar \ --data-filepath $COLLECTION_PATH/index/scitech \
--schema-filepath schema/scitech.yaml --schema-filepath schema/scitech.yaml
``` ```

View File

@ -19,4 +19,4 @@ services:
- "50000:80" - "50000:80"
volumes: volumes:
- '${COLLECTION_PATH}:/summa' - '${COLLECTION_PATH}:/summa'
version: "3.9" version: "3"

View File

@ -13,6 +13,7 @@ py_binary(
deps = [ deps = [
requirement("aioipfs"), requirement("aioipfs"),
requirement("fire"), requirement("fire"),
requirement("pyyaml"),
requirement("tantipy"), requirement("tantipy"),
requirement("izihawa_utils"), requirement("izihawa_utils"),
], ],

View File

@ -1 +1,6 @@
# Nexus Web # Nexus Web
#### Development
```shell script
bazel run web_dev
```