Name: podium
Owner: The Hyve
Description: Podium Request Portal
Created: 2017-01-31 17:23:37.0
Updated: 2017-09-12 20:52:14.0
Pushed: 2018-01-02 09:25:21.0
Size: 3535
Language: Java
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
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.
For development, you can create a Postgres database locally with psql
:
sudo -u postgres psql
te role "podiumUser" with password 'podiumUser' login;
te database "podiumUaa";
te database "podiumGateway";
t all on database "podiumUaa" to "podiumUser";
t all on database "podiumGateway" to "podiumUser";
Before you can build this project, you must install and configure the following dependencies on your machine:
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.
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.ts
file:
rt 'leaflet/dist/leaflet.js';
Edit src/main/webapp/content/css/vendor.css
file:
ort '~leaflet/dist/leaflet.css';
Note: there are still few other things remaining to do for Leaflet that we won't detail here.
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.
To launch your application's tests, run:
mvn clean test
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 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][].
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.
To set up a CI environment, consult the Setting up Continuous Integration page.