Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.58 KB

README.md

File metadata and controls

47 lines (33 loc) · 1.58 KB
Raw

SpellingCee

A clone of the NYT Spelling Bee game with some additional features (eventually).

Getting started

  1. Clone this repo
  2. pnpm install
  3. pnpm dev

To enable dictionary support (for word lookups), see Dictionary lookups.

Game keys

Games are identified by keys. A game key is a string of 7 lowercase alphabetic characters, where the first character is the “center” letter, and the other 6 letters are in alphabetical order, e.g. icerotu.

Games

Every player will be presented with the same initial game on a given day. Players may start a new game at any point. When a player opens SpellingCee on a given machine, they will be presented with the most recently active game. Players can access past games via a dropdown.

Dictionary lookups

If dictionary support is enabled, clicking a guessed word will retrieve its definition from the Merriam-Webster online dictionary and display it. To enable dictionary support, add a .env file to your local repository containing an API key, like:

SC_DICTIONARY_API_KEY="12345678-abcd-1234-12ab-1234abcd1234"

This file should not be committed to the repository.

To get an API key, visit the Merriam-Webster Developer Center and create a new developer account. Request a key for the Collegiate Dictionary. Only one key is needed. The application info (name, URL, description, launch date) is required but is not important.

Once you have created the .env file, stop and restart the development server.