Skip to content

Commit 7bd0b3d

Browse files
igordmnigordmn
authored
Fix examples, templates (JetBrains#2359)
- move screenshot into screenshots folder - add Readme, run configuration, .gitignore to web-template - fix web-compose-in-js (read versions from properties) - add global idea/ into gitignore
1 parent 521e29d commit 7bd0b3d

40 files changed

+69
-27
lines changed

‎.gitignore

+1-7
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,7 @@ out
44
*.iml
55
.gradle
66
/local.properties
7-
/.idea
8-
/.idea/caches
9-
/.idea/libraries
10-
/.idea/modules.xml
11-
/.idea/workspace.xml
12-
/.idea/navEditor.xml
13-
/.idea/assetWizardSettings.xml
7+
.idea/
148
.DS_Store
159
build/
1610
/captures

‎examples/codeviewer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ MPP Code Viewer example for desktop/android written in Multiplatform Compose lib
44

55
* To run, launch command: `./gradlew :desktop:run`
66
* Or choose **desktop** configuration in IDE and run it.
7-
![desktop-run-configuration.png](desktop-run-configuration.png)
7+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
88

99
### Building native desktop distribution
1010
```

‎examples/codeviewer/desktop-run-configuration.png ‎examples/codeviewer/screenshots/desktop-run-configuration.png

File renamed without changes.

‎examples/falling-balls/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ Falling Balls game
33
### Running desktop application
44
* To run, launch command: `./gradlew run`
55
* Or choose **desktop** configuration in IDE and run it.
6-
![desktop-run-configuration.png](desktop-run-configuration.png)
6+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
77

‎examples/falling-balls/desktop-run-configuration.png ‎examples/falling-balls/screenshots/desktop-run-configuration.png

File renamed without changes.

‎examples/imageviewer/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ An example of image gallery for remote server image viewing, based on Jetpack Co
33
### Running desktop application
44
* To run, launch command: `./gradlew :desktop:run`
55
* Or choose **desktop** configuration in IDE and run it.
6-
![desktop-run-configuration.png](desktop-run-configuration.png)
6+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
77

88
### Building native desktop distribution
99
```

‎examples/imageviewer/desktop-run-configuration.png ‎examples/imageviewer/screenshots/desktop-run-configuration.png

File renamed without changes.

‎examples/intellij-plugin-with-experimental-shared-base/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ and allows sharing Compose runtime between multiple plugins
1212
1. Start test IDE:
1313
* Run the following command in terminal: `./gradlew runIde`
1414
* Or choose **runIde** configuration in IDE and run it.
15-
![ide-run-configuration.png](ide-run-configuration.png)
15+
![ide-run-configuration.png](screenshots/ide-run-configuration.png)
1616
2. Create a new project or open any existing;
1717
3. Select `Show Compose Demo...` from the `Tools` menu.
1818

‎examples/intellij-plugin-with-experimental-shared-base/ide-run-configuration.png ‎examples/intellij-plugin-with-experimental-shared-base/screenshots/ide-run-configuration.png

File renamed without changes.

‎examples/intellij-plugin/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ To run the example:
55
1. from directory `compose-jb/examples/intellij-plugin`:
66
* Run command in terminal `./gradlew runIde`.
77
* Or choose **runIde** configuration in IDE and run it.
8-
![ide-run-configuration.png](ide-run-configuration.png)
8+
![ide-run-configuration.png](screenshots/ide-run-configuration.png)
99
2. create project or open any existing
1010
3. from menu `Tools` select `Show Compose Demo...`
1111

‎examples/intellij-plugin/ide-run-configuration.png ‎examples/intellij-plugin/screenshots/ide-run-configuration.png

File renamed without changes.

‎examples/issues/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Github Issues viewer example written in Jetpack Compose UI library.
44
### Running desktop application
55
* To run, launch command: `./gradlew :desktop:run`
66
* Or choose **desktop** configuration in IDE and run it.
7-
![desktop-run-configuration.png](desktop-run-configuration.png)
7+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
88

99
### Building native desktop distribution
1010
```

‎examples/issues/desktop-run-configuration.png ‎examples/issues/screenshots/desktop-run-configuration.png

File renamed without changes.

‎examples/notepad/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Notepad example for desktop written in Compose for Desktop library, using Compos
33
### Running desktop application
44
* To run, launch command: `./gradlew run`
55
* Or choose **desktop** configuration in IDE and run it.
6-
![desktop-run-configuration.png](desktop-run-configuration.png)
6+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
77

88
### Building native desktop distribution
99
```

‎examples/notepad/desktop-run-configuration.png ‎examples/notepad/screenshots/desktop-run-configuration.png

File renamed without changes.

‎examples/todoapp-lite/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Supported targets: Android and Desktop.
55
### Running desktop application
66
* To run, launch command: `./gradlew :desktop:run`
77
* Or choose **desktop** configuration in IDE and run it.
8-
![desktop-run-configuration.png](desktop-run-configuration.png)
8+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
99

1010
### Building native desktop distribution
1111
```

‎examples/todoapp-lite/desktop-run-configuration.png ‎examples/todoapp-lite/screenshots/desktop-run-configuration.png

File renamed without changes.

‎examples/todoapp/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Features:
3636
### Running desktop application
3737
* To run, launch command: `./gradlew :desktop:run`
3838
* Or choose **desktop** configuration in IDE and run it.
39-
![desktop-run-configuration.png](desktop-run-configuration.png)
39+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
4040

4141
#### Building native desktop distribution
4242
```
@@ -51,7 +51,7 @@ Open project in Intellij IDEA or Android Studio and run "android" configuration.
5151
### Running Web browser application
5252
* To run, launch command: `./gradlew :web:jsBrowserDevelopmentRun`
5353
* Or choose **browser** configuration in IDE and run it.
54-
![browser-run-configuration.png](browser-run-configuration.png)
54+
![browser-run-configuration.png](screenshots/browser-run-configuration.png)
5555

5656
### Running iOS application
5757

‎examples/todoapp/browser-run-configuration.png ‎examples/todoapp/screenshots/browser-run-configuration.png

File renamed without changes.

‎examples/todoapp/desktop-run-configuration.png ‎examples/todoapp/screenshots/desktop-run-configuration.png

File renamed without changes.

‎examples/visual-effects/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@ Several visual effects implmented with Compose Multiplatform, used in 1.0 releas
33
### Running desktop application
44
* To run, launch command: `./gradlew run`
55
* Or choose **desktop** configuration in IDE and run it.
6-
![desktop-run-configuration.png](desktop-run-configuration.png)
6+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
77

‎examples/visual-effects/desktop-run-configuration.png ‎examples/visual-effects/screenshots/desktop-run-configuration.png

File renamed without changes.

‎examples/web-compose-bird/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 🐦 Compose Bird
22

3-
![](demo.gif)
3+
![](screenshots/demo.gif)
44

55
![latestVersion](https://img.shields.io/github/v/release/theapache64/compose-bird)
66
<a href="https://twitter.com/theapache64" target="_blank">
@@ -18,7 +18,7 @@
1818

1919
* To run, launch command: `./gradlew jsBrowserRun`
2020
* Or choose **browser** configuration in IDE and run it.
21-
![browser-run-configuration.png](browser-run-configuration.png)
21+
![browser-run-configuration.png](screenshots/browser-run-configuration.png)
2222

2323
## 📦 Distribute
2424

‎examples/web-compose-bird/cover.jpeg

-135 KB
Binary file not shown.

‎examples/web-compose-bird/browser-run-configuration.png ‎examples/web-compose-bird/screenshots/browser-run-configuration.png

File renamed without changes.

‎examples/web-compose-bird/demo.gif ‎examples/web-compose-bird/screenshots/demo.gif

File renamed without changes.

‎examples/web-compose-in-js/README.MD

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ config.output.library = "MyComposables";
7070
### Running Web browser application
7171
* To run, launch command: `./gradlew :jsBrowserDevelopmentRun`
7272
* Or choose **browser** configuration in IDE and run it.
73-
![browser-run-configuration.png](browser-run-configuration.png)
73+
![browser-run-configuration.png](screenshots/browser-run-configuration.png)
7474

7575
### Building and using the output
7676

‎examples/web-compose-in-js/build.gradle.kts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import org.jetbrains.compose.compose
22

33
plugins {
4-
kotlin("multiplatform") version "1.6.10"
5-
id("org.jetbrains.compose") version "1.0.1"
4+
kotlin("multiplatform")
5+
id("org.jetbrains.compose")
66
}
77

88
group = "me.user"

‎examples/web-compose-in-js/gradle.properties

+2
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@ kotlin.code.style=official
22
kotlin.mpp.enableGranularSourceSetsMetadata=true
33
kotlin.native.enableDependencyPropagation=false
44
kotlin.js.webpack.major.version=4
5+
kotlin.version=1.7.10
6+
compose.version=1.2.0-beta02

‎examples/web-compose-in-js/browser-run-configuration.png ‎examples/web-compose-in-js/screenshots/browser-run-configuration.png

File renamed without changes.

‎examples/web-compose-in-js/settings.gradle.kts

+5-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@ pluginManagement {
33
gradlePluginPortal()
44
maven("https://maven.pkg.jetbrains.space/public/p/compose/dev")
55
}
6-
6+
7+
plugins {
8+
kotlin("multiplatform").version(extra["kotlin.version"] as String)
9+
id("org.jetbrains.compose").version(extra["compose.version"] as String)
10+
}
711
}
812
rootProject.name = "web-compose-in-js"
913

‎examples/web-landing/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ Landing page of Compose for Web
33
### Running Web browser application
44
* To run, launch command: `./gradlew :jsBrowserRun`
55
* Or choose **browser** configuration in IDE and run it.
6-
![browser-run-configuration.png](browser-run-configuration.png)
6+
![browser-run-configuration.png](screenshots/browser-run-configuration.png)

‎examples/web-landing/browser-run-configuration.png ‎examples/web-landing/screenshots/browser-run-configuration.png

File renamed without changes.

‎examples/web-with-react/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,4 @@ Here is a good tutorial - [Using packages from NPM](https://play.kotlinlang.org/
2121
### Running web application
2222
* To run, launch command: `./gradlew :jsBrowserRun`
2323
* Or choose **browser** configuration in IDE and run it.
24-
![browser-run-configuration.png](browser-run-configuration.png)
24+
![browser-run-configuration.png](screenshots/browser-run-configuration.png)

‎examples/web-with-react/browser-run-configuration.png ‎examples/web-with-react/screenshots/browser-run-configuration.png

File renamed without changes.

‎examples/widgets-gallery/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ demonstrating how to use various Material widgets.
1111
### Running desktop application
1212
* To run, launch command: `./gradlew :desktop:run`
1313
* Or choose **desktop** configuration in IDE and run it.
14-
![desktop-run-configuration.png](desktop-run-configuration.png)
14+
![desktop-run-configuration.png](screenshots/desktop-run-configuration.png)
1515

1616
### Building native desktop distribution
1717
```

‎examples/widgets-gallery/desktop-run-configuration.png ‎examples/widgets-gallery/screenshots/desktop-run-configuration.png

File renamed without changes.

‎templates/web-template/.gitignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
*.iml
2+
.gradle
3+
/local.properties
4+
/.idea
5+
/.idea/caches
6+
/.idea/libraries
7+
/.idea/modules.xml
8+
/.idea/workspace.xml
9+
/.idea/navEditor.xml
10+
/.idea/assetWizardSettings.xml
11+
.DS_Store
12+
build/
13+
/captures
14+
.externalNativeBuild
15+
.cxx

‎templates/web-template/.run/browser.run.xml

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<component name="ProjectRunConfigurationManager">
2+
<configuration default="false" name="browser" type="GradleRunConfiguration" factoryName="Gradle">
3+
<ExternalSystemSettings>
4+
<option name="executionName" />
5+
<option name="externalProjectPath" value="$PROJECT_DIR$" />
6+
<option name="externalSystemIdString" value="GRADLE" />
7+
<option name="scriptParameters" value="" />
8+
<option name="taskDescriptions">
9+
<list />
10+
</option>
11+
<option name="taskNames">
12+
<list>
13+
<option value=":jsBrowserRun" />
14+
</list>
15+
</option>
16+
<option name="vmOptions" />
17+
</ExternalSystemSettings>
18+
<ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
19+
<ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
20+
<DebugAllEnabled>false</DebugAllEnabled>
21+
<method v="2" />
22+
</configuration>
23+
</component>

‎templates/web-template/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Compose Web Application
2+
3+
- `./gradlew jsBrowserRun` - run application in a browser
4+
- `./gradlew jsBrowserProductionWebpack` - produce the output in `build/distributions`

0 commit comments

Comments
 (0)