Skip to content

Development

Jump to bottom
assimbly edited this page Jun 29, 2018 · 20 revisions

The project

Assimbly gateway is a web application:

  • Backend: Spring boot
  • Frontend: Angular 5+

As the main technologies are Java & Javascript (Typescript) you can develop it with any editor or IDE. We use Spring tools 4 as all have the Spring tools, but can still choose between Eclipse, Visual Studio Code or Atom.

Building the project

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.
  3. Assimbly Connector: You first need to check out and build this Maven project.

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.

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

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: Edit src/main/webapp/app/vendor.ts file:

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.

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

Building for production

To optimize the gateway application for production, run:

./gradlew -Pprod clean bootRepackage

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

./gradlew bootRepackage -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 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.

Add a new Camel component

Apache Camel has a lot more components available than supported by Assimbly. To support an extra component you first need to be sure to add this the Assimbly Connector. Be sure that the maven dependencies of the Camel component are added to the pom.xml and rebuild the project with: mvn install.

The second step is to add the component to the gateway. This has to be on the following places:

  • Add this as endpoint type in the backend (src\main\java\org\assimbly\gateway\domain\enumeration\EndpointType.java)
  • Add this as endpoint type in the frontend (src\main\webapp\app\entities\flow\flow-detail.component.ts and flow-edit-all.component.ts)
  • Add this as endpoint type for gateway (\src\main\webapp\app\entities\gateway\gateway-dialog.component.html)
  • Add this as endpoint type for error (\src\main\webapp\app\entities\error-endpoint\error-endpoint-dialog.component.html)

Now rebuild it and test the component. Some components work out-of-the-box other needs some extra requirements.

JHipster

Assimbly gateway was generated using JHipster 4.13.3, you can find documentation and help at http://www.jhipster.tech/documentation-archive/v4.13.3.

Clone this wiki locally