ulfrxdev
f691400f2b
- New "Local development" section documents docker compose + gradlew dev loop - Covers /health smoke test, env-var overrides (DATABASE_* and PORT) - Adds spotlessApply + check + down -v reference commands - Removes legacy js target docs (D-01); wasmJs target preserved
135 lines
4.5 KiB
Markdown
135 lines
4.5 KiB
Markdown
This is a Kotlin Multiplatform project targeting Android, iOS, Web, Desktop (JVM), Server.
|
||
|
||
* [/composeApp](./composeApp/src) is for code that will be shared across your Compose Multiplatform applications.
|
||
It contains several subfolders:
|
||
- [commonMain](./composeApp/src/commonMain/kotlin) is for code that’s common for all targets.
|
||
- Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
|
||
For example, if you want to use Apple’s CoreCrypto for the iOS part of your Kotlin app,
|
||
the [iosMain](./composeApp/src/iosMain/kotlin) folder would be the right place for such calls.
|
||
Similarly, if you want to edit the Desktop (JVM) specific part, the [jvmMain](./composeApp/src/jvmMain/kotlin)
|
||
folder is the appropriate location.
|
||
|
||
* [/iosApp](./iosApp/iosApp) contains iOS applications. Even if you’re sharing your UI with Compose Multiplatform,
|
||
you need this entry point for your iOS app. This is also where you should add SwiftUI code for your project.
|
||
|
||
* [/server](./server/src/main/kotlin) is for the Ktor server application.
|
||
|
||
* [/shared](./shared/src) is for the code that will be shared between all targets in the project.
|
||
The most important subfolder is [commonMain](./shared/src/commonMain/kotlin). If preferred, you
|
||
can add code to the platform-specific folders here too.
|
||
|
||
### Build and Run Android Application
|
||
|
||
To build and run the development version of the Android app, use the run configuration from the run widget
|
||
in your IDE’s toolbar or build it directly from the terminal:
|
||
|
||
- on macOS/Linux
|
||
```shell
|
||
./gradlew :composeApp:assembleDebug
|
||
```
|
||
- on Windows
|
||
```shell
|
||
.\gradlew.bat :composeApp:assembleDebug
|
||
```
|
||
|
||
### Build and Run Desktop (JVM) Application
|
||
|
||
To build and run the development version of the desktop app, use the run configuration from the run widget
|
||
in your IDE’s toolbar or run it directly from the terminal:
|
||
|
||
- on macOS/Linux
|
||
```shell
|
||
./gradlew :composeApp:run
|
||
```
|
||
- on Windows
|
||
```shell
|
||
.\gradlew.bat :composeApp:run
|
||
```
|
||
|
||
### Build and Run Server
|
||
|
||
To build and run the development version of the server, use the run configuration from the run widget
|
||
in your IDE’s toolbar or run it directly from the terminal:
|
||
|
||
- on macOS/Linux
|
||
```shell
|
||
./gradlew :server:run
|
||
```
|
||
- on Windows
|
||
```shell
|
||
.\gradlew.bat :server:run
|
||
```
|
||
|
||
### Build and Run Web Application
|
||
|
||
To build and run the development version of the web app, use the run configuration from the run widget
|
||
in your IDE's toolbar or run it directly from the terminal:
|
||
|
||
- for the Wasm target (faster, modern browsers):
|
||
- on macOS/Linux
|
||
```shell
|
||
./gradlew :composeApp:wasmJsBrowserDevelopmentRun
|
||
```
|
||
- on Windows
|
||
```shell
|
||
.\gradlew.bat :composeApp:wasmJsBrowserDevelopmentRun
|
||
```
|
||
|
||
### Build and Run iOS Application
|
||
|
||
To build and run the development version of the iOS app, use the run configuration from the run widget
|
||
in your IDE’s toolbar or open the [/iosApp](./iosApp) directory in Xcode and run it from there.
|
||
|
||
### Local development
|
||
|
||
The server requires Postgres. A `docker-compose.yml` at the repo root ships a local Postgres
|
||
instance whose credentials match `application.conf` defaults (`recipe`/`recipe`/`recipe`).
|
||
|
||
Boot the database and server:
|
||
|
||
```shell
|
||
docker compose up -d postgres
|
||
./gradlew :server:run
|
||
```
|
||
|
||
Verify the server is up:
|
||
|
||
```shell
|
||
curl http://localhost:8080/health
|
||
# expected: {"status":"ok"}
|
||
```
|
||
|
||
Environment overrides (optional — set any of these to override `application.conf` defaults):
|
||
|
||
- `DATABASE_URL` — JDBC URL (default `jdbc:postgresql://localhost:5432/recipe`)
|
||
- `DATABASE_USER` — DB user (default `recipe`)
|
||
- `DATABASE_PASSWORD` — DB password (default `recipe`)
|
||
- `PORT` — Ktor port (default `8080`)
|
||
|
||
Before committing, format all Kotlin + Gradle + Markdown files:
|
||
|
||
```shell
|
||
./gradlew spotlessApply
|
||
```
|
||
|
||
The full check (Spotless + all tests across all targets):
|
||
|
||
```shell
|
||
./gradlew check
|
||
```
|
||
|
||
Reset the local database (destroys the `recipe-pgdata` volume):
|
||
|
||
```shell
|
||
docker compose down -v
|
||
```
|
||
|
||
---
|
||
|
||
Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html),
|
||
[Compose Multiplatform](https://github.com/JetBrains/compose-multiplatform/#compose-multiplatform),
|
||
[Kotlin/Wasm](https://kotl.in/wasm/)…
|
||
|
||
We would appreciate your feedback on Compose/Web and Kotlin/Wasm in the public Slack
|
||
channel [#compose-web](https://slack-chats.kotlinlang.org/c/compose-web).
|
||
If you face any issues, please report them on [YouTrack](https://youtrack.jetbrains.com/newIssue?project=CMP). |