Merge pull request #1 from gfecher/improve-readme

Update README.md
This commit is contained in:
Feso 2019-10-21 10:56:00 +01:00 committed by GitHub
commit e0ab27d0bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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.
Please fork and PR to improve the code.