mobile-application/README.md
Ben Martin ed227bf2b6
Some checks are pending
Build / build (push) Waiting to run
docs: add README.md and update form submission logic (#21)
This commit updates the README.md with project details, including features, technologies, installation instructions, and project structure.
- It also includes a description of the app, features like free-text input, sentiment selection, submitting content to a server, and displaying a Snackbar.
- It updates the form submission logic in `App.kt` to delay showing the "Feedback sent" Snackbar by 1 second.

Closes #2

Reviewed-on: #21
Co-authored-by: Ben Martin <ben.martin@sky.uk>
Co-committed-by: Ben Martin <ben.martin@sky.uk>
2025-01-21 14:49:02 +00:00

1.1 KiB

Bob -- The Handy Feedback App

This project is a simple Kotlin Multiplatform Application that allows users to enter free-text and submit the content to a server over HTTP. It also includes a form with sentiment selection and displays a Snackbar whenever the submit button is pressed.

Features

  • Free-text input form
  • Sentiment selection using FilterChips
  • Submit content to a server using Retrofit
  • Display Snackbar on form submission

Technologies Used

  • Kotlin
  • Jetpack Compose
  • Retrofit
  • Gradle

Getting Started

Installation

  1. Download the latest release from the releases page
  2. Install the application following the on-screen instructions.

Usage

  1. Run the application on an Android emulator or a physical device.
  2. Select a sentiment using the FilterChips.
  3. Enter your text in the provided text field.
  4. Press the submit button to send the content to the server.

Project Structure

  • composeApp/src/commonMain/kotlin/uk/sky/bob/application/App.kt: Main Compose UI and form submission logic.