255 lines
8.4 KiB
Markdown
255 lines
8.4 KiB
Markdown
# epasmed
|
|
|
|
This application was generated using JHipster 6.10.4, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v6.10.4](https://www.jhipster.tech/documentation-archive/v6.10.4).
|
|
|
|
## 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.
|
|
|
|
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](package.json).
|
|
|
|
```
|
|
npm 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.
|
|
|
|
```
|
|
|
|
./mvnw
|
|
|
|
|
|
npm 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](package.json). You can also run `npm update` and `npm install` to manage dependencies.
|
|
Add the `help` flag on any command to see how you can use it. For example, `npm help update`.
|
|
|
|
The `npm run` command will list all of the scripts available to run for this project.
|
|
|
|
### PWA Support
|
|
|
|
JHipster ships with PWA (Progressive Web App) support, and it's turned off by default. One of the main components of a PWA is a service worker.
|
|
|
|
The service worker initialization code is commented out by default. To enable it, uncomment the following code in `src/main/webapp/index.html`:
|
|
|
|
```html
|
|
<script>
|
|
if ('serviceWorker' in navigator) {
|
|
navigator.serviceWorker.register('./service-worker.js').then(function () {
|
|
console.log('Service Worker Registered');
|
|
});
|
|
}
|
|
</script>
|
|
```
|
|
|
|
Note: [Workbox](https://developers.google.com/web/tools/workbox/) powers JHipster's service worker. It dynamically generates the `service-worker.js` file.
|
|
|
|
### Managing dependencies
|
|
|
|
For example, to add [Leaflet][] library as a runtime dependency of your application, you would run following command:
|
|
|
|
```
|
|
npm install --save --save-exact leaflet
|
|
```
|
|
|
|
To benefit from TypeScript type definitions from [DefinitelyTyped][] repository in development, you would run following command:
|
|
|
|
```
|
|
npm install --save-dev --save-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](src/main/webapp/app/vendor.ts) file:
|
|
|
|
```
|
|
import 'leaflet/dist/leaflet.js';
|
|
```
|
|
|
|
Edit [src/main/webapp/content/scss/vendor.scss](src/main/webapp/content/scss/vendor.scss) file:
|
|
|
|
```
|
|
@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 few 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 openapi-generator
|
|
|
|
[OpenAPI-Generator]() is configured for this application. You can generate API code from the `src/main/resources/swagger/api.yml` definition file by running:
|
|
|
|
```bash
|
|
./mvnw generate-sources
|
|
```
|
|
|
|
Then implements the generated delegate classes with `@Service` 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 reachable at [http://localhost:7742](http://localhost:7742).
|
|
|
|
Refer to [Doing API-First development][] for more details.
|
|
|
|
## Building for production
|
|
|
|
### Packaging as jar
|
|
|
|
To build the final jar and optimize the epasmed application for production, run:
|
|
|
|
```
|
|
|
|
./mvnw -Pprod clean verify
|
|
|
|
|
|
```
|
|
|
|
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/*.jar
|
|
|
|
|
|
```
|
|
|
|
Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.
|
|
|
|
Refer to [Using JHipster in production][] for more details.
|
|
|
|
### Packaging as war
|
|
|
|
To package your application as a war in order to deploy it to an application server, run:
|
|
|
|
```
|
|
|
|
./mvnw -Pprod,war clean verify
|
|
|
|
|
|
```
|
|
|
|
## Testing
|
|
|
|
To launch your application's tests, run:
|
|
|
|
```
|
|
./mvnw verify
|
|
```
|
|
|
|
### Client tests
|
|
|
|
Unit tests are run by [Jest][] and written with [Jasmine][]. They're located in [src/test/javascript/](src/test/javascript/) and can be run with:
|
|
|
|
```
|
|
npm test
|
|
```
|
|
|
|
For more information, refer to the [Running tests page][].
|
|
|
|
### Code quality
|
|
|
|
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
|
|
|
|
```
|
|
docker-compose -f src/main/docker/sonar.yml up -d
|
|
```
|
|
|
|
You can run a Sonar analysis with using the [sonar-scanner](https://docs.sonarqube.org/display/SCAN/Analyzing+with+SonarQube+Scanner) or by using the maven plugin.
|
|
|
|
Then, run a Sonar analysis:
|
|
|
|
```
|
|
./mvnw -Pprod clean verify sonar:sonar
|
|
```
|
|
|
|
If you need to re-run the Sonar phase, please be sure to specify at least the `initialize` phase since Sonar properties are loaded from the sonar-project.properties file.
|
|
|
|
```
|
|
./mvnw initialize sonar:sonar
|
|
```
|
|
|
|
For more information, refer to the [Code quality 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](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:
|
|
|
|
```
|
|
./mvnw -Pprod verify jib:dockerBuild
|
|
```
|
|
|
|
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.
|
|
|
|
[jhipster homepage and latest documentation]: https://www.jhipster.tech
|
|
[jhipster 6.10.4 archive]: https://www.jhipster.tech/documentation-archive/v6.10.4
|
|
[using jhipster in development]: https://www.jhipster.tech/documentation-archive/v6.10.4/development/
|
|
[using docker and docker-compose]: https://www.jhipster.tech/documentation-archive/v6.10.4/docker-compose
|
|
[using jhipster in production]: https://www.jhipster.tech/documentation-archive/v6.10.4/production/
|
|
[running tests page]: https://www.jhipster.tech/documentation-archive/v6.10.4/running-tests/
|
|
[code quality page]: https://www.jhipster.tech/documentation-archive/v6.10.4/code-quality/
|
|
[setting up continuous integration]: https://www.jhipster.tech/documentation-archive/v6.10.4/setting-up-ci/
|
|
[node.js]: https://nodejs.org/
|
|
[yarn]: https://yarnpkg.org/
|
|
[webpack]: https://webpack.github.io/
|
|
[angular cli]: https://cli.angular.io/
|
|
[browsersync]: https://www.browsersync.io/
|
|
[jest]: https://facebook.github.io/jest/
|
|
[jasmine]: https://jasmine.github.io/2.0/introduction.html
|
|
[protractor]: https://angular.github.io/protractor/
|
|
[leaflet]: https://leafletjs.com/
|
|
[definitelytyped]: https://definitelytyped.org/
|
|
[openapi-generator]: https://openapi-generator.tech
|
|
[swagger-editor]: https://editor.swagger.io
|
|
[doing api-first development]: https://www.jhipster.tech/documentation-archive/v6.10.4/doing-api-first-development/
|