From 500d29ab4cd263f47759244a717d1e21977c446e Mon Sep 17 00:00:00 2001 From: Feso Date: Mon, 21 Oct 2019 10:54:41 +0100 Subject: [PATCH] Update README.md --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a9896a0..c4a2b12 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,14 @@ It uses a H2 in memory database (for now), can be changed easily in the `applica # Getting started -You need Java installed. +You need Java 8 installed. ./gradlew bootRun - open http://localhost:8080 + +To test that it works, open a browser tab at http://localhost:8080/tags . +Alternatively, you can run + + curl http://localhost:8080/tags # Try it out with [Docker](https://www.docker.com/) @@ -44,6 +48,10 @@ You need Docker installed. docker-compose up -d +# Try it out with a RealWorld frontend + +The entry point address of the backend API is at http://localhost:8080, **not** http://localhost:8080/api as some of the frontend documentation suggests. + # Run test The repository contains a lot of test cases to cover both api test and repository test. @@ -52,4 +60,4 @@ The repository contains a lot of test cases to cover both api test and repositor # Help -Please fork and PR to improve the code. \ No newline at end of file +Please fork and PR to improve the code.