lukewinikates / japanese-accent Goto Github PK

View Code? Open in Web Editor NEW

0.0 3.0 0.0 12.39 MB

Shell 0.49% HTML 0.57% JavaScript 19.52% Makefile 0.17% Go 30.46% TypeScript 48.79%

japanese-accent's Introduction

Kitsutsuki - Japanese Study Studio

Introduction

This git repository contains scripts and tools for making it easier to efficiently study Japanese pitch accent.

Planned Features, Level of Progress

Pitch Accent Training

Pitch Accent Recognition
Pitch Accent Self-assessment
- Dictaphone
- Pitch contour visualization

Creating Vocabulary Lists

Creating Lessons with Embedded Vocabulary Lists, Pronunciation Guides

Kanji Practice

Who is this for?

Advanced Japanese Learners Japanese Language Instructors can use Kitsutsuki to create lessons that can easily be turned into flashcards and pronunciation practice

Technology Stack

External Sources

Suzuki-kun
OJAD
JMDict
Forvo
ffmpeg

Design of Application

Development

install go
install node/nvm/yarn
install air
install make

japanese-accent's People

Contributors

Watchers

japanese-accent's Issues

Chore: dev instance uses a different directory from the "full" install

chore: resolve deprecation warnings from material ui

feature: embed a video download utility into the installer

chore: migrate to react router 6

experiment: should we compute the waveform in JS or possibly throw it out as soon as the canvas is rendered?

I wonder how wavesurfer does it's
Computation

Features: back/next buttons for segments on the timeline

feature: zoom levels on waveform

right now, the waveform is at 100% zoom - it shows you the full song.
maybe we could support zooming

chore: fix warning from React

https://reactjs.org/blog/2022/03/08/react-18-upgrade-guide.html#updates-to-client-rendering-apis

feature: pull in thumbnails from videos

could do this by downloading full video file and processing with ffmpeg, but data volume might be a little high.

feature: suggested segments can be converted into drafts using '+' button

text management for clips

texts for clips are a little hard to work with right now. we have the text from the VTT files, but they're usually a little inaccurate and difficult to work with.

ideas

a panel for the imported vtt text, where you can relatively easily edit it
convert kanji to kana
drag-drop move texts from the list onto clips

Experiment: when a draft segment is created, check for overlaps with suggestions and pre-mute overlapped suggestions

Also when it is changed!

feature: draft segments are combined with suggested segments on the timeline

where a draft segment overlaps with a suggested segment, do not show the suggested segment
where a draft segment states that it is converted from a suggested segment, do not show the suggested segment

feature: hide/mute suggested segments

Make a delete call for the suggested segment endpoint

chore: name the project

1. Riffs on
    1. hatsuon
    2. Pitch
    3. mora (molamola?)
    4. Music terms like for scales
2. Use cute namey things like
    1. “Zaemon”
    2. “Jiro”
    3. “Min”/“rin”/cchi
3. Logo something like a tuning fork?

chore: update react version

chore: check for updates to important go dependencies

this should be an automated github aciton.

go list -m -u all
go list -m -u example.com/theirmodule
go get example.com/theirmodule@latest
go mod tidy

and open a PR with that change.

Make a list of the 'eagerly update' modules. It's probably gin, gorm, and the ffmpeg wrapper, plus prometheus and anything googly.

chore: simplify drafts data model

right now there are different tables for segments that are connected to drafts and segments that are "final" for videos.

Some ideas here:
they should be called "clips"
the source of a clip is less important than the fact that you can practice it
we could probably store the draft segments and the final segments in the same table, with a state flag on each one.

Homepage navigation should not necessarily focus so much on videos. Videos can maybe be always available as clip sources, though.

feature: add a handler for reportWebVitals and use it to populate a performance page within the app

feature: use different colored highlights for suggested vs draft items in the video draft page

feature: creating a new video clip from scratch

try: clicking a spot on the timeline
try: "add" button

experiment: editable text block on draft page, with drag/drop text blocks to associate with the draft entries

chore: encapsulate all the api calls into a typed API package

Feature: drag/drop resizing of segment on timeline adjusts its start and end via api

chore: resolve error from latest version of react-media-recorder

chore: resolve peer dependency warnings from eslint-config-react-app

warning "eslint-config-react-app > [email protected]" has unmet peer dependency "@babel/plugin-syntax-flow@^7.14.5".
warning "eslint-config-react-app > [email protected]" has unmet peer dependency "@babel/plugin-transform-react-jsx@^7.14.9".

we should show a progress screen for downloading

once it's downloaded, it can be always available for adding more clips

the editing experiences should at this point be exactly the same

warning " > @mui/[email protected]" has incorrect peer dependency "react@^17.0.0".
warning " > @testing-library/[email protected]" has unmet peer dependency "@testing-library/dom@>=7.21.4".
warning " > @typescript-eslint/[email protected]" has incorrect peer dependency "eslint@^5.0.0 || ^6.0.0 || ^7.0.0".
warning " > @typescript-eslint/[email protected]" has incorrect peer dependency "eslint@^5.0.0 || ^6.0.0 || ^7.0.0".
warning "eslint-config-react-app > [email protected]" has unmet peer dependency "@babel/plugin-syntax-flow@^7.14.5".
warning "eslint-config-react-app > [email protected]" has unmet peer dependency "@babel/plugin-transform-react-jsx@^7.14.9".
warning "react-router-dom > react-router > [email protected]" has incorrect peer dependency "react@^0.14.0 || ^15.0.0 || ^16.0.0 || ^17.0.0".
warning " > [email protected]" has incorrect peer dependency "react@^15.0.0 || ^16.0.0 || ^17.0.0".
warning " > [email protected]" has incorrect peer dependency "react-dom@^15.0.0 || ^16.0.0 || ^17.0.0".
warning " > [email protected]" has incorrect peer dependency "react@^16.13.1 || ^17.0.0".
warning " > [email protected]" has incorrect peer dependency "react-dom@^16.13.1 || ^17.0.0".
warning "use-http > [email protected]" has incorrect peer dependency "react@^16.13.1 || ^17.0.0".
warning "use-http > [email protected]" has incorrect peer dependency "react-dom@^16.13.1 || ^17.0.0".
warning "use-http > [email protected]" has incorrect peer dependency "react@^16.13.1 || ^17.0.0".
warning "use-http > [email protected]" has incorrect peer dependency "react-dom@^16.13.1 || ^17.0.0".