Skip to content

GeorgeWL/blackout-poetry

Repository files navigation

blackout-poetry

Netlify Status

Pet Project to create Blackout Poetry in the web

https://blackout.georgewl.dev

Goals

Must-have

  • Create a simple version
    • User can select words to be erased - buttons
    • Shows in UI the output
    • User can input plain unformatted text
  • Add fetch for "Search Text"
    • User can now choose between "Search" and "Manual"
  • Add fetch for "Random Text"
    • User can now choose between "Random", "Search" and "Manual"
  • "Toggle All" Button
    • In many cases will want inverse, instead of manually toggling off each word, toggling on some of the words

Could-have

  • Save as Image button

  • Copy as Text button

    • Should replace blackout words with ⬛
  • Option to filter "Random" by category/theme

  • Option to treat symbols as words

    • currently all symbols are stripped from the input text
  • Formatted Text instead of plain text

  • Allow partial selections, rather than only full words

  • Fix the Gutenberg text when bad input

    • Some gutenberg text, as the original source was OCR, is formatted wrong, with things like words that are squashed together and symbols attached to words

    image

Development

Recommended IDE Setup

VSCode + TypeScript Vue Plugin (Volar).

Type Support for .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking.

Customize configuration

See Vite Configuration Reference.

Project Setup

npm install

Compile and Hot-Reload for Development

npm run dev

Type-Check, Compile and Minify for Production

npm run build

Lint with ESLint

npm run lint