{"id":17171018,"url":"https://github.com/tipsy/kotlin-admin-template","last_synced_at":"2025-04-13T16:09:15.187Z","repository":{"id":56565199,"uuid":"306837384","full_name":"tipsy/kotlin-admin-template","owner":"tipsy","description":null,"archived":false,"fork":false,"pushed_at":"2022-10-11T16:56:08.000Z","size":99,"stargazers_count":41,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-13T16:09:06.722Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tipsy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-24T08:17:13.000Z","updated_at":"2025-01-21T06:33:41.000Z","dependencies_parsed_at":"2023-01-19T21:07:15.608Z","dependency_job_id":null,"html_url":"https://github.com/tipsy/kotlin-admin-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tipsy%2Fkotlin-admin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tipsy%2Fkotlin-admin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tipsy%2Fkotlin-admin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tipsy%2Fkotlin-admin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tipsy","download_url":"https://codeload.github.com/tipsy/kotlin-admin-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248741204,"owners_count":21154255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-14T23:33:22.260Z","updated_at":"2025-04-13T16:09:15.156Z","avatar_url":"https://github.com/tipsy.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kotlin Admin Template\n\n![Screenshot](gfx/kat.png?raw=true)\n\n## What's included?\n\n[Kotlin Admin Template](https://github.com/tipsy/kotlin-admin-template) is a starter project for a typical admin project. It has a user database with roles, authorization per endpoint, and a frontend for displaying data. The project includes the following libraries:\n\n*  [Vuetify](https://vuetifyjs.com/en/) (Material Design Vue components)\n*  [Vue](https://vuejs.org/) (JavaScript view layer library)\n*  [Javalin](https://javalin.io) (Web server library)\n*  [JDBI](https://jdbi.org/) (Database library (not an ORM))\n*  [SQLite](https://www.sqlite.org/) (Embedded database)\n\n## Running the project\n\nFrom the root directory (`kotlin-admin-template`), do:\n\n```shell\n./mvnw clean install\njava -jar target/kotlin-admin-template-jar-with-dependencies.jar\n```\n\nThe server should now be running on http://localhost:8080\n\n## Architecture\n\nThe project is packaged by feature rather than layer, for example `accounts` and `example` are packages in the project. Each feature has a `Controller` responsible for handling HTTP input and output, and a `Service` responsible for communicating with a data store (typically a database, but could also be an API).\n\nThe frontend is based on having one Vue app per URL, and routing is done server side. This allows you to re-use your auth logic for both backend and frontend routes. The frontend architecture is described in detail in [this tutorial](https://javalin.io/tutorials/simple-frontends-with-javalin-and-vue).\n\n#### Directory overview\n\n```\nkotlin-admin-template\n├──src\n│  ├──main\n│  │  ├──kotlin\n│  │  │  └──kat\n│  │  │     ├──account     //crud for user accounts\n│  │  │     ├──auth        //authentication and authorization\n│  │  │     ├──example     //an example crud feature\n│  │  │     ├──Config.kt   //application config\n│  │  │     └──Main.kt     //server config, routes and main function\n│  │  └──resources\n│  │     ├──public         //static files (logos, illustrations)\n│  │     └──vue            //vue files\n│  │        ├──components  //reusable vue components\n│  │        ├──pages       //one-off vue components (pages with URLs)\n│  │        └──layout.html //vue setup file\n│  └──test\n│     └──kotlin\n│        └──kat\n│           ├──api         //http-client tests towards api\n│           └──view        //browser tests (selenium)\n└──pom.xml\n```\n\n## Running in production?\n\nThe project is intended to get you up and running as fast as possible. Before putting this into production, you'll probably want to do a few things:\n\n*   Setup your own session database ([tutorial](https://javalin.io/tutorials/jetty-session-handling))\n*   Connect to a login provider, such as [auth0](https://auth0.com/)\n*   Replace SQLite with [PostgreSQL](https://www.postgresql.org/) (or similar)\n*   Setup a database migration tool (like [liquibase](https://liquibase.org))\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftipsy%2Fkotlin-admin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftipsy%2Fkotlin-admin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftipsy%2Fkotlin-admin-template/lists"}