Skip to content

Commit 22a29ad

Browse files
committed
docs(en): add development instructions
1 parent f57ec47 commit 22a29ad

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

docs/en/developer/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ Contributing to the open source project.
33

44
* Contributor Guidelines
55
* [Coding Standards](coding_standards.md)
6-
* Using Maven for development purposes
6+
* [Using Maven for development purposes](maven.md)
77
* [Automated Tests](tests.md)
8-
* Run OpenLRW through Docker
98
* Access to Swagger
109
* Helpers

docs/en/developer/maven.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Using Maven for development purposes
2+
3+
This following command will start the application on the port 9966 of your local machine.
4+
```
5+
$ mvn clean package spring-boot:run
6+
```
7+
8+
You can check to see if the application is running by accessing the info endpoint at http://localhost:9966/info
9+
10+
> **⚠ Note** <br>
11+
These instructions also assume that you are running MongoDB on the same machine as the LRW application (i.e., MongoDB is accessible at localhost:27017). If you need to configure the application to connect to a different MongoDB address see the [Spring-Boot & MongoDB configuration](http://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html) properties.

0 commit comments

Comments
 (0)