DEVELOPMENT.md

TeamDojo

This application was generated using JHipster 5.0.0-beta.0, you can find documentation and help at https://www.jhipster.tech/documentation-archive/v5.0.0-beta.0.

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 yarn scripts and Webpack as our build system. And postgresql as our database. For the database we use a standard docker-compose file.

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.

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

Code Formatting

Install the IntelliJ IDE EditorConfig Plugin and enable EditorConfig support

Java Format your Java code by using the IntelliJ IDE Default Code Style and organize imports before committing.

Type Script Run prettier before committing (npm run prettier:format or yarn prettier --write **/*.ts) Install IntelliJ IDE Prettier Plugin and use the action Reformat with Prettier to format the code

Line Separators Configure your IDE to use Unix LF (\n) line separators IntelliJ IDE: Line separator (for new files)

Service workers

Service workers are commented by default, to enable them please uncomment the following code.

• The service worker registering script in index.html

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

Note: workbox creates the respective service worker and dynamically generates the sw.js

Managing dependencies

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

yarn add --exact leaflet

To benefit from TypeScript type definitions from DefinitelyTyped in development, you would run the 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 can pick them up:

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

import 'leaflet/dist/leaflet.js';

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

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

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.

Using angular-cli

You can also use Angular CLI to generate some custom client code.

For example, the following command:

ng generate component my-component

will generate changes in these files:

create src/main/webapp/app/my-component/my-component.component.html
create src/main/webapp/app/my-component/my-component.component.ts
update src/main/webapp/app/app.module.ts

Doing API-First development using swagger-codegen

Swagger-Codegen is configured for this application. You can generate API code from the src/main/resources/swagger/api.yml definition file by running:

./gradlew swagger

Then implement the generated interfaces with @RestController classes.

To edit the api.yml definition file, you can use a tool such as Swagger-Editor. Start a local instance of the swagger-editor using docker by running: docker-compose -f src/main/docker/swagger-editor.yml up -d. The editor will then be located at http://localhost:7742.

Refer to Doing API-First development for more details.

Building for production

To optimize the TeamDojo application for production, run:

./gradlew -Pprod clean bootWar

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 build/libs/*.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:

./gradlew 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 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 configurations 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:

./gradlew bootWar -Pprod buildDocker

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 configuration files 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.