OncoKB Public Website

OncoKB is a precision oncology knowledge base and contains information about the effects and treatment implications of specific cancer gene alterations. Please cite Chakravarty et al., JCO PO 2017.

This application was generated using JHipster 6.10.3, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v6.10.3.

Status

Info

Development

Running environment

Make sure your running environment is the following:

Java version: 8
MySQL version: 5.7.28
Redis

Setup Redis

The following steps is one way to set up the redis. As long as you have redis setup and ready to connect, then that would work.

Install Docker
Install Kubernetes(k8s) (In Mac versin, you can enable k8s in Docker Preference)
Install helm
Install redis helm install oncokb-public-redis bitnami/redis --set auth.password=oncokb-public-redis-password --set replica.replicaCount=1
Follow the instructions after installing redis. Then you need to proxy the redis out, command looks like kubectl port-forward --namespace default svc/oncokb-public-redis-master 6379:6379

Modify config

/src/main/resources/config/application-dev.yml

Confirm database name, username, password under datasource config.
Change api-proxy-url to the URL where oncokb running. For example, http://localhost:8888/oncokb
Make sure the password for your Redis as same as the password for Redis defined in this file

Building

Before you can build this project, you must install and configure the following dependencies on your machine:

Node.js: We use Node to run a development web server and build the project. Depending on your system, you can install Node either from source or as a pre-packaged bundle.

After installing Node, you should be able to run the following command to install development tools. You will only need to run this command when dependencies change in package.json.

yarn install

We use yarn scripts and Webpack as our build system.

Run the following commands in two separate terminals to create a blissful development experience where your browser auto-refreshes when files change on your hard drive.


./mvnw


yarn start

yarn is also used to manage CSS and JavaScript dependencies used in this application. You can upgrade dependencies by specifying a newer version in package.json. You can also run yarn update and yarn install to manage dependencies. Add the help flag on any command to see how you can use it. For example, yarn help update.

The yarn run command will list all of the scripts available to run for this project.

Connect with server side locally

After starting project up locally, you should type the following command in your browser console

localStorage.setItem("localdev", true)

To unset do:

localStorage.removeItem("localdev")

localStorage.setItem("localdev", false)

PWA Support

JHipster ships with PWA (Progressive Web App) support, and it's turned off by default. One of the main components of a PWA is a service worker.

The service worker initialization code is commented out by default. To enable it, uncomment the following code in src/main/webapp/index.html:

<script>
  if ('serviceWorker' in navigator) {
    navigator.serviceWorker.register('./service-worker.js').then(function () {
      console.log('Service Worker Registered');
    });
  }
</script>

Note: Workbox powers JHipster's service worker. It dynamically generates the service-worker.js file.

Managing dependencies

For example, to add Leaflet library as a runtime dependency of your application, you would run following command:

yarn add --exact leaflet

To benefit from TypeScript type definitions from DefinitelyTyped repository in development, you would run following command:

yarn add --dev --exact @types/leaflet

Then you would import the JS and CSS files specified in library's installation instructions so that Webpack knows about them: Note: There are still a few other things remaining to do for Leaflet that we won't detail here.

For further instructions on how to develop with JHipster, have a look at Using JHipster in development.

Building for production

Packaging as jar

To build the final jar and optimize the oncokb application for production, run:


./mvnw -Pprod clean verify

This will concatenate and minify the client CSS and JavaScript files. It will also modify index.html so it references these new files. To ensure everything worked, run:


java -jar target/*.jar

Then navigate to http://localhost:9090 in your browser.

Refer to Using JHipster in production for more details.

Packaging as war

To package your application as a war in order to deploy it to an application server, run:


./mvnw -Pprod,war clean verify

Packaging with a docker image ready


    ./mvnw package -Pprod verify jib:dockerBuild -DskipTests

Testing

To launch your application's tests, run:

./mvnw verify

Client tests

Unit tests are run by Jest and written with Jasmine. They're located in src/test/javascript/ and can be run with:

yarn test

For more information, refer to the Running tests page.

Screenshot tests

Screenshot tests are run by Jest, Puppeteer. They're located in screenshot-test/. Because different dev environments have different systems, which may cause the resulting image doesn’t quite match the expected one from the __baseline_snapshots__ directory saved in source control, we dockerized the test process and can be run with:

yarn run screenshot-test-in-docker

If you are confident with the changes from the __diff_output__ directory, you have two options to update the images stored in the __baseline_snapshots__ directory.

yarn run screenshot-test-in-docker:update

repalce the out-of-date images with the up-to-date images stored in __latest_snapshots__.

NOTE: The cmds above can only be executed in unix-based systems. If you are using Windows, please use docker-compose build local_test ,docker-compose run --rm local_test to run the tests, and use docker-compose build local_test_update, docker-compose run --rm local_test_update to update baseline images.

If you don't want to use docker, you can just use

yarn run screenshot-test

to run the tests and use

yarn run screenshot-test:update

to update baseline images. However, please keep in mind that the result images may not match the baseline images even you didn't change any thing. And the tests in CI process may fail as well.

Why Puppeteer?

We used jest w/ puppeteer instead of Webdriverio w/ Selenium basically based on below pros:

Simple to set up, good document and easy to handle on.
Maintained by Google and it gives you direct access to the CDP.
Faster execution speed.
Network interception. Your test codes can record, modify, block or generate responses to requests made by the browser.
JavaScript first, so the code feels very natural

Code quality

Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:

docker-compose -f src/main/docker/sonar.yml up -d

You can run a Sonar analysis with using the sonar-scanner or by using the maven plugin.

Then, run a Sonar analysis:

./mvnw -Pprod clean verify sonar:sonar

If you need to re-run the Sonar phase, please be sure to specify at least the initialize phase since Sonar properties are loaded from the sonar-project.properties file.

./mvnw initialize sonar:sonar

For more information, refer to the Code quality page.

Using Docker to simplify development (optional)

You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.

For example, to start a mysql database in a docker container, run:

docker-compose -f src/main/docker/mysql.yml up -d

To stop it and remove the container, run:

docker-compose -f src/main/docker/mysql.yml down

You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:

./mvnw -Pprod verify jib:dockerBuild

Then run:

docker-compose -f src/main/docker/app.yml up -d

For more information refer to Using Docker and Docker-Compose, this page also contains information on the docker-compose sub-generator (jhipster docker-compose), which is able to generate docker configurations for one or several JHipster applications.

Continuous Integration (optional)

To configure CI for your project, run the ci-cd sub-generator (jhipster ci-cd), this will let you generate configuration files for a number of Continuous Integration systems. Consult the Setting up Continuous Integration page for more information.

bulksecuritygeneratorprojectv2 / oncokb__oncokb-public Goto Github PK

oncokb__oncokb-public's Introduction