Skip to content

Commit 40c59e8

Browse files
Merge pull request #1154 from PathwayCommons/v.2.1.0
merge v2.1.0 release (need to tag it)
2 parents 501f718 + 65d66f0 commit 40c59e8

File tree

126 files changed

+15927
-6584
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

126 files changed

+15927
-6584
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@
44
## Required software
55

66
- [Node.js](https://nodejs.org/en/) >=6.3.0
7-
7+
- [RethinkDB](https://www.rethinkdb.com/) >=2.3.6
8+
- [Chromium](https://www.chromium.org/Home)
89
## Running the App Locally
9-
1. Install rethinkdb and run it by typing the command in your terminal
10+
1. Start rethinkdb by typing this command in your terminal
1011
```
1112
rethinkdb
1213
```
@@ -19,7 +20,7 @@ npm install
1920

2021
For development:
2122
```
22-
npm run watch
23+
npm run watch
2324
```
2425

2526
For a production build:
@@ -40,21 +41,21 @@ The following environment variables can be used to configure the server:
4041
1. Download [RethinkDB](https://www.rethinkdb.com/docs/install/)
4142
2. Start your RethinkDB server by following the steps [here](https://www.rethinkdb.com/docs/start-a-server/)
4243
3. Go to `src/server/database/config.js` and modify the ip field to match your server address
43-
4. Start the project : `npm run start` or `npm run watch`, then the server will auto create all the required tables for you.
44+
4. Start the project : `npm run start` or `npm run watch`, then the server will auto create all the required tables for you.
4445

4546
### Switching Pathway Commons Versions (release/other)
4647

4748
If Pathway Commons data and files have been updated since this app's last built and run,
48-
or you simply want to connect to a different PC2 instance (and set PC_URL environment variable),
49-
then the file `src/server/graph-generation/generic-physical-entities/generic-physical-entity-map.json`
49+
or you simply want to connect to a different PC2 instance (don't forget to set PC_URL),
50+
then the file `src/server/graph-generation/biopax-metadata/generic-physical-entity-map.json`
5051
needs to be updated. Also, purge the RethinkDb db tables or simply switch the database.
5152

5253
The following script downloads and processes physical_entities.json.gz file from Pathway Commons:
5354
```sh
5455
cd src/scripts/generic-entity-mapping/
5556
PC_VERSION=v10 sh update.sh
5657
```
57-
(PC_VERSION should be set to the name of a sub-directory in `www.pathwaycommons.org/archives/PC2/`)
58+
(PC_VERSION should be set to the name of a sub-directory in `www.pathwaycommons.org/archives/PC2/`)
5859

5960
## Run targets
6061

@@ -100,15 +101,15 @@ Notes:
100101

101102
### Run image hosted on Docker Hub using Docker Compose
102103

103-
Pathway Commons maintains a [Docker Hub](https://hub.docker.com/) image for [app-ui](https://hub.docker.com/r/pathwaycommons/app-ui/) that is automatically built each time a commit is pushed to GitHub.
104+
Pathway Commons maintains a [Docker Hub](https://hub.docker.com/) image for [app-ui](https://hub.docker.com/r/pathwaycommons/app-ui/) that is automatically built each time a commit is pushed to GitHub.
104105

105106
To run the GitHub development branch:
106107

107108
```sh
108109
docker-compose --file docker-compose.yml up --detach
109110
```
110111

111-
Access the app instance at port `9090`.The default configuration declared in `docker-compose.yml` also runs a [rethinkdb](https://hub.docker.com/_/rethinkdb/) image; access the UI at port `8020`.
112+
Access the app instance at port `9090`.The default configuration declared in `docker-compose.yml` also runs a [rethinkdb](https://hub.docker.com/_/rethinkdb/) image; access the UI at port `8020`.
112113

113114
Notes:
114115
- References:
@@ -159,7 +160,7 @@ Students who work on the repo should follow these instructions for each feature
159160
1. Using the console: `git checkout name-of-feature`, `git merge development`
160161
1. Using GitUp:
161162
1. Make sure your `HEAD` is the newest commit of your feature branch: Right-click the latest commit on `name-of-feature` branch and select `Checkout "name-of-feature" Branch`
162-
1. Right-click the latest commit of the `development` branch and select `Merge into Current Branch`
163+
1. Right-click the latest commit of the `development` branch and select `Merge into Current Branch`
163164
1. Push your commits to GitHub:
164165
1. Note: You can push as often as you'd like so that your code is backed up on GitHub. You *must* push everything before you make a pull request.
165166
1. Using the console: `git push`
@@ -180,4 +181,3 @@ Students who work on the repo should follow these instructions for each feature
180181
1. For a breaking API change, run `npm version major.`
181182
1. For a specific version number (e.g. 1.2.3), run `npm version 1.2.3`.
182183
1. Push the release: `git push origin --tags`
183-

0 commit comments

Comments
 (0)