/uma

Simple user management CRUD application based on Kotlin

Primary LanguageKotlin

UMA - user management app

Simple rest service to store user data.

Technologies

  • Kotlin - programming language
  • Spring - web framework
  • Postgres - db
  • Spring JPA - ORM tool
  • Junit - testing framework
  • mockk.io - mocking framework
  • assertk - assertion framework
  • gradle - building tool
  • Docker - well, docker ¯\(ツ)/¯

Documentation

Please go to swagger ui to check API documentation once it's running.

How to run

Pre-requirements

  1. Make sure you have gradle 7.6 installed
  2. Make sure you have java 17 installed
  3. Make sure you have docker installed

Steps

  1. Pull project locally
  2. Go to the project root directory and build it with ./gradlew build. You should have out folder now.
  3. Now you can start the app with docker compose up --build
  4. Enjoy 😄

Troubleshooting

If it doesn't work, try to run postgres db separately on port 5432, and then run the app from Intellij 🙃