Portuguese | 日本語

API WordView

The main goal of the API is to provide lyrics and video subtitles filled by data generated by the gengolex library. The API responds to the app a JSON containing both the original text track and a structured breakdown of all words within it.

With this information, the application makes additional requests to the API to retrieve image representations for each word, enabling the generation of the text visuals and lessons.

In addition, the API includes a complete system for account creation and user authentication.

Running

  # Clone the repository
  git clone https://github.com/word-view/APIWordView

  # Enter the folder
  cd APIWordView/

  # run
  ./mvnw spring-boot:run

Running (JAR)

Using the releases JAR is not recommended because it may not work as expected with the latest app version.

  # Download from releases
  # And run either with --prod (production) or --dev
  java -jar ./wordview-0.0.4-SNAPSHOT-exec.jar --prod