Docker container:

CircleCI build:

OpenTargets Web App

This is the web app for the Open Targets Platform, based on the Open Targets REST API. The app is based on Angular, while D3 is used for visualization and graphs.

Usage (run your own copy of the webapp)

Depending on how you deploy, you might want to do two things:

change the API the webapp points to
apply a custom.json config that overrides the value in app/config/<general,dictionary,datatypes,datasources>/default.json,

for example to change evidence_sources displayed

NB: In general, you shouldn't use custom.json to override the {"api":} variable of the app, otherwise the deploy steps described below will fail.

Deploy on netlify

Fork the webapp (unless you are a member of the Open Targets team who deploys to production 😄 )
(optional) add a custom.json to /app/config/**/ to change your fork's configuration. When deploying with netlify, the custom.json cannot be changed without first commiting it to the code.
Set up netlify/github integration, including specifying the build steps (yarn run full-setup) and the directory served (app).
Change the netlify.toml to point to your API. The app will point to the API specified with APIHOST in the netlify.toml file.

Deploy using our docker image

A docker image with a compiled version of the webapp from a NGINX web server is available on quay.io

To start a container locally using the image:

docker run -d -p 8443:443 -p 8080:80 quay.io/opentargets/webapp

Then visit https://localhost:8443

The standard image comes with self-signed certificates, so you will have click through a couple of security warnings to get to the app. To add your own certificates, run something like this:

docker run -d -p 8443:443 -p 8080:80 \
 -v <my_ssl_dir>/server.crt:/usr/share/nginx/server.crt \
 -v <my_ssl_dir>/server.key:/usr/share/nginx/server.key \
 quay.io/opentargets/webapp

If you want to point to the docker container to an API server different than the production one:

You can specify the variables:

REST_API_SCHEME (http or https are valid options, https is the default)
REST_API_SERVER (e.g. rest_api to point to a container named rest_api or api.opentargets.io to point to the production api; platform-api.opentargets.io is the default)
REST_API_PORT (default is the HTTPS/443 port)

Example:

docker run -d -p 8443:443 -p 8080:80 \
 -e "REST_API_SCHEME=https" \
 -e "REST_API_SERVER=devapi.appspot.com" \
 -e "REST_API_PORT=443" \
 quay.io/opentargets/webapp

By default, the webapp /proxy should redirect to the proxy that is built into the rest api container. But it is also possible to specify a separate server for all /proxy calls (calls to external services and data resources used in some pages). These are the variables:

PROXY_SCHEME (http or https are valid options, $REST_API_SCHEME is the default)
PROXY_SERVER (if not set, $REST_API_SERVER is the default)
PROXY_PORT (if not set, $REST_API_PORT is the default)
PROXY_PATH (if not set, proxy is the default)

ℹ️ When using the rest api built-in proxy, additional domains can be included by adding them to the appropriate nginx configuration file. See https://github.com/opentargets/rest_api/ documentation for more details.

Any other modifications, including changing the custom.json for the container, cannot be made at runtime. You'd have to create your own fork/modifications. Read on to the developing section.

Developing (change and contribute to the code)

Prerequisites

Installation and tests need some node.js tools: you must have node.js and its package manager npm installed. You can get them from http://nodejs.org/

Install

Clone the repository and install the dependencies. Tools are installed via NPM (and yarn)

git clone https://github.com/opentargets/webapp.git
cd webapp
yarn run full-install

This installs the required node modules and calls jspm install which takes care of all Angular dependencies and 3rd party widgets. So these commands create three directories:

node_modules - npm packages for the needed tools (http-server and modules for testing); also all Angular code.
app/jspm_packages - some of the packages needed for loading widgets on demand (deferred loading)

Angular code is installed via Bower includes:

UI Bootstrap (Angular directives)
Bootstrap (css)
FontAwesome (css)
D3

Build

After you make your changes you will want to build and run the application:

set the APIHOST env variable to point to a fully functional rest_api. Notice that APIHOST can be of the form "https://somesite.com:1234/api/" (recommended) or a simple prefix /api/ if you are taking care of reverse-proxying the API there (for eg if you are serving the app locally in nginx)
(optional) add a custom.json with your configurations to override the ones contained in default.json
run yarn run setup
all the code you need for deployment will be contained in /app.
to point to a different API (or update your custom.json) and not have to rebuild the whole app, you can change the APIHOST env var (or custom.json) and then run only gulp build-config. ℹ️ To use this feature, make sure to have gulp installed (npm install -g gulp) and run gulp instead of yarn in step 3 above (gulp build-all).

Running the app

Any webserver that can serve the /app directory will do.

NOTE to have a fully functional app, you also need to have your web server to reverse proxy /proxy to a valid rest_api server. For an example of running the app, you can look at how the build and deployment is done for nginx in the Dockerfile of this project.

Building custom images using docker

Use our nginx based Dockerfile

You can run a nginx webserver using docker. We have a Dockerfile that is derived from nginx:alpine which you can use.

To build:

docker build . -t webapp-image

To run: see section "Deploy using our docker image" above.

If you want to change the nginx configuration, you can change the nginx_conf/nginx.template before running the build step above.

Branch images on quay

If you push some changes to a branch of the main repo, a container with the tag of the branch will be publicly available after a few minutes on quay.io

docker pull quay.io/opentargets/webapp:<yourbranchname>

Further documentation

Plugins

Read about how to create platform plugins here.

04linsi / webapp Goto Github PK

webapp's Introduction