Visualizer2

Getting started

(The following assume you're at the project root.)

User accounts

Out of the box, two accounts are created: admin and user. The passwords are initially admin and user, respectively. You may want to change that when you're up and running.

In the new visualizer, games are owned by the user who logged in to create/start them. To account for this, the log files are now written to user-specific directories, e.g. "files/admin/log".

In the new visualizer, games are owned by the user who logged in to create/start them. To account for this, the log files are now written to user-specific directories, e.g. "files/admin/log".

Modes and Profiles

There are four mode/profile-specific configuration files

You can run the visualizer in two modes, "research" and "tournament". In the first case, you will get some additional tabs in the GUI to start/stop games, which are run embedded in the visualizer. In the second case, you will be able to passively view the progress of games run by an external tournament scheduler.

Additionally, you can build the visualizer with "dev" or in "prod" profiles, the latter meaning that the javascript, styles, and HTML templates will be concatenated and compressed -- making the pages slightly faster to load.

So you will have to pick one of four combinations. To run the visualizer in, for instance, research mode and production profile, do

mvn -Pprod,research

This will select the default Maven goal, which is spring-boot:run. Alternatively, you can select the package goal to build a WAR file, e.g. in tournament mode and production profile:

mvn -Pprod,tournament package

Note, this will create two WAR files, in the target directory. One contains an embedded Tomcat servlet container, and can be run as an executable jar:

java -jar target/xxxxx.war

The other WAR file is called xxxxx.war.original and can be deployed to external servlet containers like Tomcat 8.

Unless you're actually developing the visualizer itself, you'll probably want to use the "prod" profile. However, this will cause the build process to take a long time, in particular it will be doing a lot of tests. If you would like to skip these, you can add -DskipTests to your Maven commands.

JHipster generic documentation

This application was generated using JHipster 4.0.6, you can find documentation and help at https://jhipster.github.io/documentation-archive/v4.0.6.

Development

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

1. 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.
2. 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 Gulp as our build system. Install the Gulp command-line tool globally with:

yarn global add gulp-cli

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
gulp

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

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

Building for production

To optimize the visualizer2 application for production, run:

./mvnw -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.

Refer to Using JHipster in production for more details.

Testing

To launch your application's tests, run:

./mvnw 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:

gulp test

For more information, refer to the Running tests 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 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 jhipster: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.