First Commit

README.md

@@ -0,0 +1,126 @@
+Bugs:
+
+- state management in Challenge (also asset select and user select)
+- cash updating
+- favorize system
+
+Concept:
+
+- Challenge with other people with set amount of money and time with the goal goal to make as much money as possible
+-
+
+Features:
+
+- Search Stocks
+- “Buy / Sell” Stocks
+- Save / Get Data vie Alpaka API (probably the Broker API)
+- Comparison with average
+- Random Avatars using https://robohash.org/
+
+Optional Features:
+
+- Leverage
+- Analytics
+- Challenge in specific Region / Sector etc
+- Comparison with all-world etf
+
+This is a Kotlin Multiplatform project targeting Android, 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.
+* [/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
+      ```
+- for the JS target (slower, supports older browsers):
+    - on macOS/Linux
+
+      ```shell
+      ./gradlew :composeApp:jsBrowserDevelopmentRun
+      ```
+    - on Windows
+
+      ```shell
+      .\gradlew.bat :composeApp:jsBrowserDevelopmentRun
+      ```
+
+---
+
+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).