jwmickey / five-letter-salad

Experimental/educational project to learn about Vue3

Five Word Salad

This is an educational project to learn a little about Vue3. The project is obviously based on the popular Wordle game presented by The New York Times. The game selects from a relatively short (~500) list of words to avoid selecting a very uncommon word such as "baize", profanity, words that are plural forms of base words, etc.

If you are interested in playing the actual game, I strongly recommend you go to the Times and enjoy the official game which has well thought out words, player history, sharing results with friends, etc.

Changelog

[0.0.3] - 23 Dec 2022

Added history manager to export/import/erase game history

[0.0.2] - 25 Nov 2022

Replaced custom css with Tailwind

[0.0.1] - 8 Oct 2022

Added local storage to save current game progress. For you, Grandma!

[0.0.0] - 20 Sep 2022

First working game

Recommended IDE Setup

VSCode + Volar (and disable Vetur) + 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. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

1. Disable the built-in TypeScript Extension
   1. Run Extensions: Show Built-in Extensions from VSCode's command palette
   2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
2. Reload the VSCode window by running Developer: Reload Window from the command palette.

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

Run Unit Tests with Vitest

npm run test:unit

Run End-to-End Tests with Cypress

npm run build
npm run test:e2e # or `npm run test:e2e:ci` for headless testing

Lint with ESLint

npm run lint