It is a template for a Kotlin backend project. It is based on the ktor framework and uses [Exposed]
This template I created for myself and my personal projects, but I decided to share it with you. I hope it will be useful to you.
We must install first Docker and Docker compose.
- First we have to define .env file.
- Execute make develop
This have to deploy server and swagger documentation with the information defined in the .env
Example environment file.
ENVIRONMENT=DEV >
PORT_LISTEN=3000 > IP_LISTEN=0.0.0.0 >
JWT_AUDIENCE=general > JWT_REALM=realm > JWT_SECRET=berlin-truth-scandal-glow-mobilize-reappoint > SWAGGER_ENDPOINT=docs > SWAGGER_URL=http://0.0.0.0:3000 >
JWT_EXPIRATION_TIME=600000 > POSTGRES_URL=jdbc:postgresql://database:5432/ktor_database > POSTGRES_USERNAME=root > POSTGRES_PASSWORD=root >
REFRESH_TOKEN_EXPIRATION_TIME=21600000 > USER_UUID_DEV=1000:1000
- make environment-test, this command execute environment test
Execute with android studio test you want to execute.
You have to define a environment var to point database url connection to localhost, due to container is not accesible from host machine by a name.
Example
- MINIO_URL=http://localhost:9000;
- POSTGRES_URL=jdbc:postgresql://localhost:5432/ktor_database
What did taken into account to choose this tech stack?
- Stability of library.
- Library must be preferably DSL or DSL friendly.
- Compatible with Kotlin Native if possible.
- Open software.
- Easy to use.
- Koin Injection dependencies
- SQL Exposed
- JWT
- Clean arquitecture
- Swagger-UI
- Dot-Env
- Faker
- Valiktor(Request validations)
- Hikary connection(JDBC Handler)
- Gradle Kts.
- KtLint
- PostgresSql
- BCrypt
- Scripts for seeding projecta
- Dockerized project
- Continuous integration(Github actions and link with docker), code coverage and deploy.
- Some storage(Minio/ Firebase, other alternative)
- Ktlint format
Test stack
- Faker
- Kotest
- Kotest assertion
- Koin test injection
If you think my work is useful to you, you can buy me a cofee.
