Skip to content

Latest commit

 

History

History
109 lines (86 loc) · 3.34 KB

README.md

File metadata and controls

109 lines (86 loc) · 3.34 KB
Raw




dropd logo

A quiz component

Package version. Make a pull request. First-timers Friendly

Word Coach is simply a replica of the Google word coach built in React. You can see the orginal Google Word coach in action by searching "Google Word coach" on Google via your mobile device. This project may only be used for learning purposes as the initial idea is from Google.

Demo

I've built an interactived demo to help you see the comp

Go to Demo

Installation

yarn add @word-coah/react

Contributing

See Contributing

📝 License

Licensed under the MIT License

Todo

All

@word-coach/react

  • Use streamed data over fake data
  • add onChunk callback
  • Prevent highlight overflow
  • Introduce modes ["stream|static"]
  • Prevent moving or skipping if next chunk hasn't arrived, move to next when data arrives
  • Cleanup themes - Make sure all themes looks nice
  • Fix EndGameScreen
  • Fetch again on "Next Round" for stream mode
  • In stream mode: sometimes the data is fetch but can't proceed to next question
  • Fully wire props with UI
  • Inject link preload to document to load images ahead of time
  • ❌ Back state up in localStorage - hydation issues happening
  • General code cleanup
  • Write test with playright
  • TS type for css & svg
  • Ship to NPM
  • Deploy same in-react example to codesandbox(setup pipline for that)
  • Switch styling solution
  • Docs

@word-coach/ai-questions

  • Fix CSV parsing in Library
  • image fetching may messs with order of question index in stream
  • Write tests
  • Docs
  • Add "why answer"

wordcoach.xyz(Not yet released)

  • Build UI for mode and render based on props based on mod
  • Build UI for progress
  • Copy Code Feature
  • Open on CodeSandbox
  • Block Requests not coming from wordcoach.xyz
  • Incoporate modes
  • Show stream progress in stream mode
  • Debounce stremEndPoint input element
  • Add Sentry to Catch Errors in Production
  • Switch to ShadcnUI/Radix UI