diff --git a/readme.md b/readme.md index 8641114a4f815dab222660a429e7919a1537f858..85bc03e888df3380453d261546ece7b0c67d0e2b 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@ -#  +# Mobildata-server -> ### Kotlin + Spring codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the [RealWorld](https://github.com/gothinkster/realworld-example-apps) spec and API. +> ### Collecting, storing, processing and visualizing data from smart phones This codebase was created to demonstrate a fully fledged fullstack application built with Kotlin + Spring including CRUD operations, authentication, routing, pagination, and more. @@ -8,7 +8,22 @@ We've gone to great lengths to adhere to the Kotlin + Spring community styleguid For more information on how to this works with other frontends/backends, head over to the [RealWorld](https://github.com/gothinkster/realworld) repo. -# How it works +## Mobil Client + +TODO + +## Collected data types + +`TODO` + +## API + +The Rest API documentation can be found on `http://<IP-address>:8080/v2/api-docs` after +deploying and running the server. + +The Json description is produced with [Swagger](https://swagger.io/) + +## Architecture The application uses Spring (Web, Data, AOP, Cache) and the Kotlin language. @@ -23,8 +38,6 @@ The application uses Spring (Web, Data, AOP, Cache) and the Kotlin language. Object for REST in/out operations JPA models + repository/ - + specification/ - Some specifications for JPA Spring repositories + service/ Spring services @@ -41,20 +54,11 @@ The secret key and jwt issuer are stored in `application.properties`. # Database -It uses a H2 in memory database (for now), can be changed easily in the `application.properties` for any other database. -You'll need to add the correct maven dependency for the needed `Driver` in `pom.xml`. +It uses PostgreSQL database -# Getting started +# Build and run You need Java and maven installed. mvn spring-boot:run open http://localhost:8080 - -# Help - -Please fork and PR to improve the code. - -# Kotlin - -I've been using Kotlin for some time, but I'm no expert, so feel free to contribute and modify the code to make it more idiomatic!