summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFiete Ostkamp <Fiete.Ostkamp@telekom.de>2022-09-19 16:55:36 +0200
committerFiete Ostkamp <Fiete.Ostkamp@telekom.de>2022-09-19 16:55:36 +0200
commit7343beeaf260747aef6a6b9c22acd91de67c5ca0 (patch)
treecc90d98dfb61d5066184b346612bb04caaae64b4 /README.md
parente0ad4f2890f9f933199bc6f1b3f0e988da471aa9 (diff)
Add instructions to invoke the linter and code formatter plugins to the README and invoke the formatter
Issue-ID: AAI-3526 Signed-off-by: Fiete Ostkamp <Fiete.Ostkamp@telekom.de> Change-Id: Ibd383994732cea6460153704a1153beb530dc6c3
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.md b/README.md
index a504159..6b8bcab 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,20 @@
# AAI Schema Service
+## Development
### Local setup
-
In order to start the service locally, here is what needs to be done
-
-```
-> mvn clean install
+``` bash
+mvn clean install
```
-Above command only needs to be run the first time
+Above command only needs to be run the first time.
The command below actually starts the microservice
-
+``` bash
+mvn -pl aai-schema-service -PrunAjsc
```
-> mvn -pl aai-schema-service -PrunAjsc
+
+### Run code formatter
+``` bash
+mvn formatter:format spotless:apply process-sources
```