Skip to content

Commit

Permalink
Readme improvements (#99)
Browse files Browse the repository at this point in the history
* Updated readme to reflect need for jdk14+, and add draft section on mongo setup.

* Added default mongo host for localhost on development profile.

* Fixed protocol for mongo uri.
  • Loading branch information
kburger authored Jan 20, 2021
1 parent 5343ea4 commit 8e2ac5e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,22 @@ More information about FDP and how to deploy can be found at [FDP Deployment Doc

**Stack:**

- **Java** (recommended JDK 14)
- **Java** (minimally JDK 14, or higher)
- **Maven** (recommended 3.2.5 or higher)
- **Docker** (recommended 17.09.0-ce or higher) - *for build of production image*

### Build & Run

Run these commands from the root of the project
To run the application, a mongodb instance is required to be running. To configure the mongodb address, instruct spring-boot to use the `development` profile. Run these commands from the root of the project.

```bash
$ mvn spring-boot:run -Dspring-boot.run.profiles=development
```

Alternatively, create an `application.yml` file in the project root and [configure the mongodb address](https://fairdatapoint.readthedocs.io/en/latest/deployment/advanced-configuration.html#mongo-db), and then run these commands from the root of the project.

```bash
$ mvn spring-boot:start
$ mvn spring-boot:run
```

### Run tests
Expand Down
7 changes: 6 additions & 1 deletion src/main/resources/application-development.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,9 @@ ping:
security:
jwt:
token:
expiration: 999
expiration: 999

spring:
data:
mongodb:
uri: mongodb://localhost:27017/fdp

0 comments on commit 8e2ac5e

Please sign in to comment.