Skip to content

Latest commit

 

History

History
68 lines (53 loc) · 2.41 KB

README.md

File metadata and controls

68 lines (53 loc) · 2.41 KB

SlangApp Code Challenge

👋 Hello Slang Evaluator :)

This is a small project por the code challenge that you sent to me

Before we start

For generating disctractors I'm using phonemes, In my research I found some common mistakes that people make and are related to minimal pairs (See here, and here, and here). So I need the dictionary file to get the actual word phoneme and then I've created a table where I've mapped the common mistakes.
For example:

This phoneme gets confused with Example
/ɪ/ /i:/ sit and seat
/f/ /v/ fan and van
/b/ /p/ buy and pie

An so on...

Prerequisites

  • Postgres database
  • AWS Account with API credentials, I'm using Amazon Polly TTS for generating Audio file and I'm saving them on a S3 (If you want to test it locally I can share mine)
  • A Dictionary file that is on src/main/resources/static/ (This is used to get the word phoneme) this can be later changed for a API than returns phoneme

Installation

For AWS config complete the following information on the application.properties file

aws.api.accessKey=
aws.api.secretKey=
aws.s3.url=
aws.s3.bucketName=

For Postgres db config complete the following information on the application.properties file

spring.datasource.url=
spring.datasource.username=
spring.datasource.password=

For creating the db and generating initial data uncomment the following props

#spring.jpa.generate-ddl=true
#spring.jpa.hibernate.populate=true
#spring.jpa.hibernate.ddl-auto=create

For running this app you would have to clone the repository and make the following steps

  • Clone or download the project
  • Install Dependencies with Maven
mvn clean install
  • Import project to IDE
  • ✅ And enjoy testing
mvn spring-boot:run

Live Demo and Doc