Welcome to the Podium Request Portal

Podium is the request portal for samples, data and images from BBMRI Biobanks, with the purpose to uniformize the request and review processes for all associated users and organisations.

The application scaffold was generated using JHipster 4.0.0, you can find documentation and help at https://jhipster.github.io/documentation-archive/v4.0.0.

This application is configured for Service Discovery and Configuration with the Podium-Registry. On launch, it will refuse to start if it is not able to connect to the Podium-Registry at http://localhost:8761.

What is Podium?

Development

Setup database

For development, you can create a Postgres database locally with psql: sudo -u postgres psql

create role "podiumUser" with password 'podiumUser' login;
create database "podiumUaa";
create database "podiumGateway";
grant all on database "podiumUaa" to "podiumUser";
grant all on database "podiumGateway" to "podiumUser";

Dependencies

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.
Yarn: We use Yarn to manage Node dependencies. Depending on your system, you can install Yarn 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 npm 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.

mvn
yarn start

[Npm][] 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.

Adding 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:

Edit src/main/webapp/app/vendor.tsfile:

import 'leaflet/dist/leaflet.js';

Edit src/main/webapp/content/css/vendor.css file:

@import '~leaflet/dist/leaflet.css';

Note: there are still few other things remaining to do for Leaflet that we won't detail here.

Building for production

To optimize the podiumGateway application for production, run:

mvn -Pprod clean package

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/*.war

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

Testing

To launch your application's tests, run:

mvn clean test

Client tests

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

yarn test

For UI end-to-end tests see the READMEs of the individual components

Performance tests

Performance tests are run by Gatling and written in Scala. They're located in src/test/gatling and can be run with:

mvn gatling:execute

For more information, refer to the [Running tests page][].

Using Docker to simplify development (optional)

You can use Docker to improve your Podium 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 postgresql database in a docker container, run:

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

To stop it and remove the container, run:

docker-compose -f src/main/docker/postgresql.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:

mvn package -Pprod docker:build

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 (yo podium:docker-compose), which is able to generate docker configurations for one or several JHipster applications.

Continuous Integration (optional)

To set up a CI environment, consult the Setting up Continuous Integration page.

strangepleasures / podium