Initial commit

Author: modularizer

.gitignore

@@ -0,0 +1,62 @@
+# Built application files
+*.apk
+*.ap_
+*.aab
+
+# Files for the Dalvik VM
+*.dex
+
+# Java class files
+*.class
+
+# Generated files
+bin/
+gen/
+out/
+
+# Gradle files
+.gradle/
+build/
+
+# Local configuration file (sdk path, etc)
+local.properties
+
+# Proguard folder generated by Eclipse
+proguard/
+
+# Log Files
+*.log
+
+# Android Studio Navigation editor temp files
+.navigation/
+
+# Android Studio captures folder
+captures/
+
+# IntelliJ
+*.iml
+.idea/
+.idea_modules/
+
+# Keystore files
+*.jks
+*.keystore
+
+# External native build folder generated in Android Studio 2.2 and later
+.externalNativeBuild/
+
+# Google Services (e.g. APIs or Firebase)
+google-services.json
+
+# Freeline
+freeline.py
+freeline/
+freeline_project_description.json
+
+# Fabric properties
+fabric.properties
+
+# Crashlytics configuations
+com_crashlytics_export_strings.xml
+crashlytics-build.properties
+crashlytics.properties

LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

README.md

@@ -0,0 +1,75 @@
+# Hello World Keyboard
+
+Welcome to the Hello World Keyboard project! 
+This custom Android keyboard is a perfect starting point for first-time Android developers interested in exploring custom keyboard development. 
+The keyboard features three simple buttons that input "hello", "world", and "keyboard".
+
+![Keyboard Gif](./images/use.gif)
+
+## Getting Started
+
+These instructions will guide you through forking the project, making it your own, and setting up a development environment for testing and further development.
+
+### Prerequisites
+
+Before you start, ensure you have Android Studio installed, the official IDE for Android app development:
+
+- [Install Android Studio](https://developer.android.com/studio/install)
+
+### Forking and Cloning the Project
+
+1. **Fork the Repository**:
+    - Visit the original repository at `https://github.com/modularizer/helloworldkeyboard`.
+    - Click on the `Fork` button at the top right corner of the page to create a copy of the repository in your GitHub account.
+
+2. **Clone Your Fork**:
+    - After forking, go to your GitHub account where the new repository exists.
+    - Open the forked repository and click on `Code` to get the clone URL.
+    - Copy the URL.
+
+3. **Import the Project in Android Studio**:
+    - Open Android Studio.
+    - Go to `File` > `New` > `Project from Version Control`.
+    - In the URL field, paste the URL of your forked repository.
+    - Choose your preferred directory and click `Clone`.
+
+### Running and Testing the Project
+
+1. **Set Up an Emulator**:
+    - Go to Tools > Device Manager > Create Device to create a new Virtual Device.
+    - Choose a device definition and a system image.
+
+2. **Run the App**:
+    - With the emulator open, run the app from Android Studio.
+
+3. **Enable and Test the Keyboard**:
+    - In the emulator, navigate to `Settings` (hint: double-tap the top bar, swipe down, find the gear icon)
+    - In Settings, search `Manage on-screen Keyboards` or navigate to `Settings` > `System` > `Languages & input` > `On-screen keyboard` > `Manage on-screen keyboards`.
+    - Enable `Hello World Keyboard`.
+    - Open any text field, and in the bottom right corner of the screen, tap the keyboard icon to switch to your new keyboard.
+
+![Setup Gif](./images/setup.gif)
+
+## Customizing Your Keyboard
+### Key Files for Customization
+- `app/src/main/java/com.example.helloworldkeyboard/KeyboardService.kt`: Main service for keyboard logic.
+- `app/src/main/res/keyboard_layout.xml`: Layout file for the keyboard UI.
+- `app/src/main/res/values/strings.xml`: Strings file for keyboard UI text.
+- `app/src/main/AndroidManifest.xml`: App declarations and configurations.
+
+### Tips for Designing Your Keyboard
+- **Layout**: Modify `keyboard_layout.xml` for UI changes.
+- **Functionality**: Adapt `KeyboardService.kt` for different key actions.
+- **Testing**: Always test changes on an emulator or device.
+
+## Contributing
+
+This project is open to contributions with the goal of making an absolute bare-bones keyboard for first-time Android developers,
+encouraging best practices and good coding habits while also providing a starting point for further development.
+Feel free to fork this repository, make your changes, and submit pull requests to contribute to this project.
+
+## License
+
+This project is 100% open source and free to use for any purpose.
+This project is licensed under the [Unlicense](https://unlicense.org) - see the [LICENSE](LICENSE) file for details.
+

app/.gitignore

@@ -0,0 +1 @@
+/build

app/build.gradle.kts

@@ -0,0 +1,46 @@
+plugins {
+    id("com.android.application")
+    id("org.jetbrains.kotlin.android")
+}
+
+android {
+    namespace = "com.example.helloworldkeyboard"
+    compileSdk = 34
+
+    defaultConfig {
+        applicationId = "com.example.helloworldkeyboard"
+        minSdk = 24
+        targetSdk = 34
+        versionCode = 1
+        versionName = "1.0"
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+}
+
+dependencies {
+
+    implementation("androidx.core:core-ktx:1.9.0")
+    implementation("androidx.appcompat:appcompat:1.6.1")
+    implementation("com.google.android.material:material:1.8.0")
+    testImplementation("junit:junit:4.13.2")
+    androidTestImplementation("androidx.test.ext:junit:1.1.5")
+    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
+}

app/proguard-rules.pro

@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile

app/src/androidTest/java/com/example/helloworldkeyboard/ExampleInstrumentedTest.kt

@@ -0,0 +1,24 @@
+package com.example.helloworldkeyboard
+
+import androidx.test.platform.app.InstrumentationRegistry
+import androidx.test.ext.junit.runners.AndroidJUnit4
+
+import org.junit.Test
+import org.junit.runner.RunWith
+
+import org.junit.Assert.*
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * See [testing documentation](http://d.android.com/tools/testing).
+ */
+@RunWith(AndroidJUnit4::class)
+class ExampleInstrumentedTest {
+    @Test
+    fun useAppContext() {
+        // Context of the app under test.
+        val appContext = InstrumentationRegistry.getInstrumentation().targetContext
+        assertEquals("com.example.helloworldkeyboard", appContext.packageName)
+    }
+}

app/src/main/AndroidManifest.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools">
+
+    <application
+        android:allowBackup="true"
+        android:dataExtractionRules="@xml/data_extraction_rules"
+        android:fullBackupContent="@xml/backup_rules"
+        android:icon="@mipmap/ic_launcher"
+        android:label="@string/app_name"
+        android:roundIcon="@mipmap/ic_launcher_round"
+        android:supportsRtl="true"
+        android:theme="@style/Theme.HelloWorldKeyboard"
+        tools:targetApi="31">
+        <service
+            android:name=".KeyboardService"
+            android:label="@string/service_label"
+            android:enabled="true"
+            android:exported="true"
+            android:permission="android.permission.BIND_INPUT_METHOD">
+        <intent-filter>
+            <action android:name="android.view.InputMethod" />
+        </intent-filter>
+        <meta-data
+            android:name="android.view.im"
+            android:resource="@xml/method" />
+    </service>
+
+    </application>
+
+</manifest>

app/src/main/java/com/example/helloworldkeyboard/KeyboardService.kt

@@ -0,0 +1,31 @@
+package com.example.helloworldkeyboard
+
+import android.inputmethodservice.InputMethodService
+import android.view.View
+import android.widget.Button
+
+class KeyboardService : InputMethodService() {
+    override fun onCreateInputView(): View {
+        // Inflate your keyboard layout from the XML file
+        val inflater = layoutInflater
+        val inputView = inflater.inflate(R.layout.keyboard_layout, null)
+
+        // Get references to your buttons
+        val buttonHello = inputView.findViewById<Button>(R.id.button_hello)
+        val buttonWorld = inputView.findViewById<Button>(R.id.button_world)
+        val buttonKeyboard = inputView.findViewById<Button>(R.id.button_keyboard)
+
+        // Set click listeners for your buttons
+        buttonHello.setOnClickListener { inputText("hello") }
+        buttonWorld.setOnClickListener { inputText("world") }
+        buttonKeyboard.setOnClickListener { inputText("keyboard") }
+
+
+        return inputView
+    }
+
+    private fun inputText(text: String) {
+        val inputConnection = currentInputConnection
+        inputConnection?.commitText(text, 1)
+    }
+}