Skip to content

ThingooKNI/backend

Repository files navigation

Thingoo backend (REST API + auth server)

Codacy Badge Codacy Badge

Requirements:

  • Docker
  • Docker compose
  • JDK 11+
  • ktlint (for formatting, optional)

Running Thingoo backend alone:

You can run Thingoo backend standalone, with Spring Security disabled, by just running regular Spring Boot application with "dev" profile active.

Running Thingoo backend with all dependencies (auth server etc.):

Running app for development

./scripts/start-dev.sh

Applying code changes:

./scripts/reload-dev.sh

Watching application logs:

docker logs backend -f 

Stopping the app

./scripts/stop-dev.sh

Format code with ktlint

./scripts/format.sh

Project documentation

https://www.notion.so/Thingoo-24b12d89c3d644c8ba88c1c8ac29c38d

Deployment

Backend is deployed on Kubernetes cluster and is accessible through following URLs:

Default credentials for Keycloak's admin console:

username: admin

password: password

Postman Collection

For easier client's implementation, we provide Postman collection with all endpoints provided by the API:

https://app.getpostman.com/join-team?invite_code=e7a9f0d3527e5f429ee64eaf84d723dc

OpenAPI Specification (Swagger)

https://app.swaggerhub.com/apis/BartlomiejRasztabiga/thingoo-rest_api/