civic-client uses npm for development, build, and resource server tasks, so ensure that you have npm (and node) installed and running. Checkout this repository and cd to it, then:
npm install
Then head to Starbucks, get a coffee, read that new Pikettey book everyone's been talking about, return to your workstation and install the bower package management system:
npm install -g bower
and finally, use bower to install civic-client's runtime libraries:
bower install
If bower becomes confused about which Angular version to use, pick the first one that offers version 1.3.15.
Fire up the civic-server on port 3000 and run:
gulp serve
Then head to http://127.0.0.1:3001
in your browser. NOTE: use 127.0.0.1
, not localhost
. A couple of the OAuth providers we use for authentication will only work if the app is loaded from 127.0.0.1
.
The serve
tasks starts a static file server, and a proxy that routes calls to /api to the civic-server listening on port 3000. It serves the AngularJS application, and a starts a watch task which watches all files for changes and lints, builds and injects them into the index.html accordingly.
To make the app ready for deploy to production run:
gulp build
The build task creates a ./dist
folder with all scripts and stylesheets concatenated, minified, and versioned, also third party libraries installed with bower will be concatenated and minified into vendors.min.js
and vendors.min.css
respectively.
To test the build version of the app, execute:
gulp serve:dist
This task executes a build, then serves the /dist directory from the same port as the gulp serve
task, http://127.0.0.1:3001/
As the civic-client is under heavy development, we'll be pushing releases to the master branch at a fairly rapid rate. Often, we'll update various packages and modules that are part of the workflow and/or production codebase. So after you do a git pull
to update your local repository, be sure to:
npm install
bower install
This will install any new packages or modules that the new updates require.
- Personalized Cancer Therapy Knowledge Base for Precision Oncology (MD Anderson Cancer Center)
- My Cancer Genome - Genetically Informed Cancer Medicine (Vanderbilt-Ingram Cancer Center)
- Targeted Cancer Care (Massachusetts General Hospital)
Browse Genes in the CIViC database:
View and comment on revisions to Genes, Variants, Evidence Items: