Update README.md
This commit is contained in:
parent
67fee0aa9e
commit
500d29ab4c
14
README.md
14
README.md
@ -33,10 +33,14 @@ It uses a H2 in memory database (for now), can be changed easily in the `applica
|
|||||||
|
|
||||||
# Getting started
|
# Getting started
|
||||||
|
|
||||||
You need Java installed.
|
You need Java 8 installed.
|
||||||
|
|
||||||
./gradlew bootRun
|
./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/)
|
# Try it out with [Docker](https://www.docker.com/)
|
||||||
|
|
||||||
@ -44,6 +48,10 @@ You need Docker installed.
|
|||||||
|
|
||||||
docker-compose up -d
|
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
|
# Run test
|
||||||
|
|
||||||
The repository contains a lot of test cases to cover both api test and repository 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
|
# Help
|
||||||
|
|
||||||
Please fork and PR to improve the code.
|
Please fork and PR to improve the code.
|
||||||
|
Loading…
Reference in New Issue
Block a user