/voice-crud

Primary LanguageTypeScriptMIT LicenseMIT

Voice-Controlled Issue Tracker

A modern issue tracking application with voice control capabilities. Built with Hilla (Vaadin), Spring Boot, and OpenAI's real-time voice API.

Features

  • Voice-controlled interface for hands-free operation
  • Real-time issue management
  • Filter issues by assignee
  • Create, delete, and select issues using voice commands
  • Update issue properties (title, description, status, assignee) with voice
  • Responsive web interface

Technologies

  • Frontend:

    • React + TypeScript
    • Hilla framework
    • WebRTC for real-time voice communication
    • OpenAI's real-time API for voice processing

  • Backend:

    • Spring Boot
    • Java

Prerequisites

  • Java 17 or newer
  • Node.js 18 or newer
  • OpenAI API key with access to real-time voice models

Setup

  1. Clone the repository
  2. Set your OpenAI API key as an environment variable: 
    export OPENAI_API_KEY=your_api_key_here

Running the application

The project is a standard Maven project. To run it from the command line:

  • Windows: mvnw
  • Mac & Linux: ./mvnw

Then open http://localhost:8080 in your browser.

You can also import the project to your IDE of choice as you would with any Maven project.

Voice Control Usage

  1. Click the "Enable Voice Control" button in the application
  2. Once activated, you can use voice commands such as:
    • "Filter issues assigned to [name]"
    • "Show all issues"
    • "Create a new issue"
    • "Delete current issue"
    • "Select issue number [id]"
    • "Update the current issue's title to [title]"
    • "Change the status to in progress"
    • "Assign this issue to [name]"
    • "Update the description to [description]"

Project structure

DirectoryDescription
src/main/frontend/Client-side source directory
    components/React components including voice control
    views/UI view components
    themes/Custom CSS styles
src/main/java/Server-side source directory
    application/Java services and models

Building for Production

To create a production build:

  • Windows: mvnw clean package -Pproduction
  • Mac & Linux: ./mvnw clean package -Pproduction

This will build a JAR file with all the dependencies and front-end resources, ready to be deployed. The file can be found in the target folder after the build completes.

To run the production build:

java -jar target/voice-crud-1.0-SNAPSHOT.jar

Useful links