Skip to content

Commit

Permalink
Merge pull request #21 from joeflack4/docs-updates
Browse files Browse the repository at this point in the history
Update quick_start.md
  • Loading branch information
Dazhi Jiao authored Jul 8, 2021
2 parents 28fbce3 + d26cbe2 commit fb20665
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@ git clone
git submodule update --init --recursive
```

Because the PDC json files are under git lfs, install git-lfs if you
haven't, then pull the content with git lfs.
Because the PDC json files are under Git LFS (Large File Storage), it must be installed in the repository. Follow [these instrucions](https://git-lfs.github.com/) for installling Git LFS on your machine. Then, install it in the repo via `git lfs install`. Then, pull the content with git lfs.

```shell
cd crdc-nodes/PDC-Public/documentation/prod/json
Expand All @@ -26,9 +25,9 @@ First copy the TCCM NCIT Turtle RDF to the docker import directory for neo4j.
cp data/tccm/ncit-termci.ttl docker/neo4j/import
```

Create a .env file with required environment variables.
In the `docker/` folder, Create a `.env` file with required environment variables.

The .env file should contain the following:
The `.env` file should contain the following:

```
NEO4J_BOLT_URI=bolt://host:port
Expand All @@ -38,6 +37,8 @@ NEO4J_HOST=ccdh-neo4j
NEO4J_BOLT_PORT=port
```

Choose whatever username, password, and port you want. The typical default port number for NEO4J projects is `7687`, if you'd like to use that.

By default, the importer will pull the CRDC-H YAML from the main branch of the ccdhmodel GitHub repo.
If another branch is preferred, you can add this line in the .env file.

Expand Down Expand Up @@ -67,4 +68,4 @@ python -m ccdh.importers.importer
```

After data is loaded, the server will be running on a local port at 7070. You can visit
http://localhost:7070.
http://localhost:7070.

0 comments on commit fb20665

Please sign in to comment.