https://github.com/johannschopplich/wordle-pwa
🦊 Wordle app to fork and customize for your friends
https://github.com/johannschopplich/wordle-pwa
nuxt-template vuejs wordle
Last synced: 7 months ago
JSON representation
🦊 Wordle app to fork and customize for your friends
- Host: GitHub
- URL: https://github.com/johannschopplich/wordle-pwa
- Owner: johannschopplich
- License: mit
- Created: 2022-03-20T21:45:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-14T16:20:44.000Z (about 1 year ago)
- Last Synced: 2025-03-22T21:04:50.273Z (7 months ago)
- Topics: nuxt-template, vuejs, wordle
- Language: Vue
- Homepage: https://wordle-pwa.pages.dev
- Size: 3.07 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Wordle PWA
Customizable Wordle app for your friends and family
Explore the demo »
# Wordle PWA
A refactored and extended Vue app of [VVordle](https://github.com/yyx990803/vue-wordle) by Evan You, which itself is a implementation of the original [Wordle game](https://www.nytimes.com/games/wordle/index.html).
Built with [Nuxt](https://nuxt.com).
## Key Features
- 🐤 Beautiful interface
- 🎞 Custom answer sources (environment variables or Google Spreadsheet)
- ⌨️ Optional `umlauts` keyboard layout
- 🇫🇷 Supports french by sanitizing accented characters
- 💆♀️ Styled with [UnoCSS](https://github.com/unocss/unocss)
## Setup
1. Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
2. Install dependencies using `pnpm install`
3. Start the development server using `pnpm run dev`
4. Visit [127.0.0.1:5173](http://127.0.0.1:5173/)
> [!NOTE]
> Enable [Take Over Mode](https://vuejs.org/guide/typescript/overview.html#takeover-mode) in Visual Studio Code.
## Usage
### Start Date
Especially for a custom word list you probably prefer to start the list by a date of your choice. Wordle PWA will calculate the difference between the current date and the start date and pick the answer at the array index based from the date difference.
```ini
NUXT_PUBLIC_STARTS_AT=2023-12-01
```
### Base64
You can make your own one-time Wordle and send it to friends by base64-encoding a word and include it as the URL query, e.g. [`wordle-pwa.pages.dev/?anVsaWE=`](https://wordle-pwa.pages.dev/?anVsaWE=). This will also allow words that are not in the dictionary.
### Custom Word List
#### Within `.env` File
A custom word list may be set in the app's `.env` file:
```ini
NUXT_PUBLIC_ANSWERS=birds,floor,umami
```
> [!NOTE]
> Remember to set a start date as well.
#### Words From Google Spreadsheet
Alternatively, the app will fetch words from any public Google spreadsheet if the following entries exist in the app's `.env` file:
```ini
NUXT_GOOGLE_API_KEY=...
NUXT_PUBLIC_GOOGLE_SHEETS_ID=1nO4y9FBuOr4_lA50rIldeWUAvqKYpcJYf5h1tpBybZU
NUXT_PUBLIC_GOOGLE_SHEETS_TABLE=Wordle 2023
```
## License
[MIT](./LICENSE) License © 2022-PRESENT [Johann Schopplich](https://github.com/johannschopplich)
[MIT](./LICENSE) License © 2022 [Evan You](https://github.com/yyx990803)
The original creator(s) of Wordle own all applicable rights to the game itself.