You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+6-2
Original file line number
Diff line number
Diff line change
@@ -11,16 +11,19 @@
11
11
12
12
[](https://tree.taiga.io/project/monogrammbot-monogrammjhipster-template/ "Managed with Taiga.io")
Copy file name to clipboardexpand all lines: docs/README.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,9 @@
3
3
This directory contains the code for the **JHipster template** docs site, [monogramm.github.io/jhipster-template](https://monogramm.github.io/jhipster-template).
4
4
5
5
References:
6
-
*[Publish Your Project Documentation with GitHub Pages](https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/)
6
+
7
+
-[Publish Your Project Documentation with GitHub Pages](https://github.blog/2016-08-22-publish-your-project-documentation-with-github-pages/)
7
8
8
9
## Contributing
9
10
10
11
For information about contributing, see the [Contributing page](https://github.com/Monogramm/jhipster-template/blob/master/CONTRIBUTING.md).
Copy file name to clipboardexpand all lines: docs/jhipster.md
+28-21
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
1
# JHipster template
2
2
3
-
This application was generated using JHipster 6.4.1, you can find documentation and help at [https://www.jhipster.tech/documentation-archive/v6.4.1](https://www.jhipster.tech/documentation-archive/v6.4.1).
3
+
This application was generated using JHipster 6.4.1, you can find documentation and help at <https://www.jhipster.tech/documentation-archive/v6.4.1>.
4
4
5
5
## Development
6
6
7
7
Before you can build this project, you must install and configure the following dependencies on your machine:
8
8
9
-
1.[Node.js][]: We use Node to run a development web server and build the project.
10
-
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
9
+
1.[Node.js][]: We use Node to run a development web server and build the project.
10
+
Depending on your system, you can install Node either from source or as a pre-packaged bundle.
11
11
12
12
After installing Node, you should be able to run the following command to install development tools.
13
13
You will only need to run this command when dependencies change in [package.json](package.json).
@@ -32,7 +32,7 @@ The `npm run` command will list all of the scripts available to run for this pro
32
32
33
33
Service workers are commented by default, to enable them please uncomment the following code.
34
34
35
-
- The service worker registering script in index.html
35
+
-The service worker registering script in index.html
36
36
37
37
```html
38
38
<script>
@@ -59,15 +59,11 @@ To benefit from TypeScript type definitions from [DefinitelyTyped][] repository
59
59
Then you would import the JS and CSS files specified in library's installation instructions so that [Webpack][] knows about them:
Note: there are still few other things remaining to do for Leaflet that we won't detail here.
73
69
@@ -96,7 +92,7 @@ To ensure everything worked, run:
96
92
97
93
java -jar target/*.jar
98
94
99
-
Then navigate to [http://localhost:8080](http://localhost:8080) in your browser.
95
+
Then navigate to <http://localhost:8080> in your browser.
100
96
101
97
Refer to [Using JHipster in production][] for more details.
102
98
@@ -120,24 +116,18 @@ For more information, refer to the [Running tests page][].
120
116
121
117
### Code quality
122
118
123
-
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
119
+
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on <http://localhost:9001>) with:
124
120
125
-
```
126
-
docker-compose -f src/main/docker/sonar.yml up -d
127
-
```
121
+
docker-compose -f src/main/docker/sonar.yml up -d
128
122
129
123
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.
130
124
Then, run a Sonar analysis:
131
125
132
-
```
133
-
./mvnw -Pprod clean verify sonar:sonar
134
-
```
126
+
./mvnw -Pprod clean verify sonar:sonar
135
127
136
128
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.
137
129
138
-
```
139
-
./mvnw initialize sonar:sonar
140
-
```
130
+
./mvnw initialize sonar:sonar
141
131
142
132
or
143
133
For more information, refer to the [Code quality page][].
@@ -163,20 +153,37 @@ For more information refer to [Using Docker and Docker-Compose][], this page als
163
153
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.
164
154
165
155
[jhipster homepage and latest documentation]: https://www.jhipster.tech
0 commit comments