Make sure there's no accidental space before or after the word

README.md

@@ -9,8 +9,107 @@ Using Alpine.js on the frontend and FastAPI as backend.
 
 ## Environment variables
 
-```
+```fish
 set -x WORD_LIST /path/to/alfagok_wordlist.txt
 set -x START_DATE 2024-11-02
 set -x DICTIONARY_LIST /path/to/dictionary.txt
 ```
+
+In `src/alfagok`, with an active virtualenv with packages installed (`uv pip sync requirements.txt`), run:
+
+`fastapi dev main.py`
+
+
+## Example configs
+
+### nginx
+
+/etc/nginx/sites-enabled/alfagok.example.com.conf
+
+```nginx
+server {
+    listen [::]:443 ssl; # managed by Certbot
+    listen 443 ssl; # managed by Certbot
+    server_name alfagok.example.com;
+
+    real_ip_header      X-Forwarded-For;
+
+    access_log  /var/log/nginx/access_alfagok.example.com.log;
+    error_log  /var/log/nginx/error_alfagok.example.com.log  warn;
+
+    location / {
+        proxy_pass             http://127.0.0.1:8889;
+        proxy_read_timeout     60;
+        proxy_connect_timeout  60;
+        proxy_redirect         off;
+
+        # Allow the use of websockets
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection 'upgrade';
+        proxy_set_header Host $host;
+        proxy_cache_bypass $http_upgrade;
+    }
+
+    ssl_certificate /etc/letsencrypt/live/alfagok.example.com/fullchain.pem; # managed by Certbot
+    ssl_certificate_key /etc/letsencrypt/live/alfagok.example.com/privkey.pem; # managed by Certbot
+    include /etc/letsencrypt/options-ssl-nginx.conf; # managed by Certbot
+    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
+
+}
+server {
+    if ($host = alfagok.example.com) {
+        return 301 https://$host$request_uri;
+    } # managed by Certbot
+
+    listen [::]:80;
+    listen 80;
+    server_name alfagok.example.com;
+    return 404; # managed by Certbot
+}
+```
+
+### systemd unit file
+
+/etc/systemd/system/alfagok.service
+
+```ini
+[Unit]
+Description=Gunicorn Daemon for alfagok game FastAPI
+After=network.target
+
+[Service]
+User=USERNAME (fill in!)
+Group=USERGROUP (fill in!)
+WorkingDirectory=/srv/www/alfagok.example.com/alfagok/src
+
+Environment="START_DATE=2024-11-02"
+Environment="WORD_LIST=/srv/www_data/alfagok.example.com/wordlist.txt"
+Environment="DICTIONARY_LIST=/srv/www_data/alfagok.example.com/dictionary.txt"
+Environment="STATIC_DIR=/srv/www/alfagok.example.com/alfagok/src/alfagok/static"
+Environment="TEMPLATE_DIR=/srv/www/alfagok.example.com/alfagok/src/alfagok/templates"
+
+ExecStart=/srv/www/alfagok.example.com/venv/bin/gunicorn -c /srv/www/_webconfig/sites/alfagok.example.com/gunicorn_alfagok_conf.py alfagok.main:app
+
+[Install]
+WantedBy=multi-user.target
+```
+
+### gunicorn config file
+
+```python
+# gunicorn_conf.py
+from multiprocessing import cpu_count
+
+bind = "127.0.0.1:8889"
+
+# Worker Options
+#workers = cpu_count() + 1
+workers = 1
+worker_class = 'uvicorn.workers.UvicornWorker'
+
+# Logging Options, dir should be writable for User in systemd unit file
+loglevel = 'debug'
+accesslog = '/var/log/alfagok/access_log'
+errorlog = '/var/log/alfagok/error_log'
+```

src/alfagok/static/game.css

@@ -1,6 +1,45 @@
 body {
     background-color: #333;
     color: #FFF;
+
+    max-width: 600px;
+    margin: 0 auto;
+    padding: 2rem 1rem;
+}
+
+[x-cloak] { display: none !important; }
+
+a.title {
+    color: #FF9800;
+    font-weight: bold;
+    text-decoration: none;
+    font-size: 1.5rem;
+}
+
+.puzzleno {
+    border: 1px solid grey;
+    color: grey;
+    padding: .2em .5em;
+    border-radius: 1em;
+    text-align: right;
+    float: right;
+}
+
+#container center {
+    padding-top: 2rem;
+}
+
+.instructions {
+    padding: 2rem 0 0 0;
+}
+
+.guessesheading {
+    color: #CCC;;
+}
+
+input[type="text"] {
+    box-sizing: border-box;
+    width: 100%;
 }
 
 button {
@@ -8,5 +47,33 @@ button {
     color: #333;
 
     border: 0;
-    padding: .2rem;
+    margin-top: .5rem;
+
+    cursor: pointer;
+
+    width: 100%;
+}
+
+ul {
+    list-style-type: none;
+    padding-left: 0;
+}
+
+.error {
+    background-color: #F00;
+    color: #FFF;
+}
+
+input[type="text"], button, .error {
+    padding: .5rem;
+    font-size: 1.5rem;
+}
+
+.win {
+    background-color: rgb(42 73 54);
+    padding: 1rem;
+}
+
+.results {
+    background-color: #333;
 }

src/alfagok/static/game.js

@@ -1,43 +1,111 @@
-/* API calls **/
+document.addEventListener('alpine:init', () => {
-async function doGuess(guessWord) {
+    Alpine.store('alfagok', {
-    Alpine.store('alfagok').loading = true;
+        /* Main alfagok application, state etc */
-        Alpine.store('alfagok').guessError = null;
+        gameID: 0,
-    if (guessWord === '') {
-        console.log('Nothing filled in');
-        Alpine.store('alfagok').guessError = 'Vul een woord in';
-        return;
-    }
 
-    Alpine.store('alfagok').nrGuesses++;
+        loading: false,
-    if (Alpine.store('alfagok').startTime === '') {
-        console.log('Setting startTime to now');
-    }
 
-    let response = await fetch('/api/guess/' + guessWord);
+        winTime: null,
-    let result = await response.json();
+        startTime: null,
-    console.log(result);
 
-    Alpine.store('alfagok').loading = false;
+        nrGuesses: 0,
-    if (result.error) {
+        guessesBefore: [],
-        console.log('Error occurred during guess');
+        guessesAfter: [],
-        if (result.error === 'Word not in dictionary') {
+
-            Alpine.store('alfagok').guessError = 'Woord komt niet in de woordenlijst voor';
+        guessValue: '',
+
+        guessError: '',
+
+        resultGameID: '',
+        resultGuesses: '',
+        resultTimeTaken: '',
+
+        async getGameID() {
+            /* Get the game number from the backend */
+            this.loading = true;
+            console.log('Loading gameID...');
+            let response = await fetch('/api/game');
+            let result = await response.json();
+            console.log(result);
+            this.loading = false;
+            if (result.game) {
+                return this.gameID = result.game;
+            }
+        },
+
+        async doGuess() {
+            this.guessError = null;
+
+            /* Normalise on lowercase, and strip whitespace from begin and end, just in case */
+            this.guessValue = this.guessValue.toLowerCase().trim();
+
+            if (this.guessValue === '') {
+                console.log('Nothing filled in');
+                this.guessError = 'Vul een woord in';
+                return;
+            }
+            if (this.guessesBefore.includes(this.guessValue) || this.guessesAfter.includes(this.guessValue)) {
+                this.guessError = 'Woord is al gebruikt';
+                return;
+            }
+
+            if (this.startTime === null) {
+                console.log('Setting startTime to now');
+                this.startTime = new Date();
+            }
+
+            /* Check guess against server */
+            this.loading = true;
+
+            let response = await fetch('/api/guess/' + this.guessValue);
+            let result = await response.json();
+            console.log(result);
+
+            this.loading = false;
+
+            if (result.error) {
+                console.log('Error occurred during guess');
+                if (result.error === 'Word not in dictionary') {
+                    this.guessError = 'Woord komt niet in de woordenlijst voor';
+                }
+                return;
+            }
+            this.nrGuesses++;
+            if (result.hint && result.hint === 'after') {
+                this.guessesBefore.push(this.guessValue);
+                this.guessesBefore.sort();
+                this.guessValue = '';
+            }
+            if (result.hint && result.hint === 'before') {
+                this.guessesAfter.push(this.guessValue);
+                this.guessesAfter.sort();
+                this.guessValue = '';
+            }
+            if (result.hint && result.hint === 'it') {
+                console.log('gevonden!');
+                this.winTime = new Date();
+                this.resultGameID = '🧩 Puzzel #' + this.gameID;
+                this.resultGuesses = '🤔 '+ this.nrGuesses + ' gokken';
+                this.resultTimeTaken = '⏱️ ' + getFormattedTime(this.winTime - this.startTime);
+            }
         }
-        return;
+    }),
-    }
+
-    if (result.hint && result.hint === 'after') {
+    Alpine.store('darkMode', {
-        console.log('na');
+        /* Different Alpine app, dark mode settings for the game */
-        Alpine.store('alfagok').guessesBefore.push(guessWord);
+        init() {
-    }
+            this.on = window.matchMedia('(prefers-color-scheme: dark)').matches
-    if (result.hint && result.hint === 'before') {
+        },
-        console.log('voor');
+
-        Alpine.store('alfagok').guessesAfter.push(guessWord);
+        on: false,
-    }
+
-    if (result.hint && result.hint === 'it') {
+        toggle() {
-        console.log('gevonden');
+            this.on = ! this.on
-        Alpine.store('alfagok').winTime = 'yay';
+        }
-    }
+    })
-}
+
+});
+
 
 /* Time formatting **/
 
@@ -53,7 +121,7 @@ function getFormattedTime(milliseconds) {
 
     const formattedTime = [];
     if (hours) {
-        formattedTime.push(`${hours}h`);
+        formattedTime.push(`${hours}u`);
     }
     if (minutes) {
         formattedTime.push(`${minutes}m`);
@@ -102,3 +170,11 @@ function addZero(num){
 }
 
 go();
+
+
+/* Get current gameID etc **/
+
+document.addEventListener('alpine:initialized', () => {
+    /* On AlpineJS completely loaded, do all this */
+    Alpine.store('alfagok').getGameID();
+})

src/alfagok/templates/index.html

@@ -4,128 +4,70 @@
         <title>alfagok</title>
         <meta charset="UTF-8">
         <meta name="viewport" content="width=device-width, initial-scale=1.0">
+        <meta name="description" content="Raad het woord van de dag. Elke gok geeft een hint over waar het woord zich in het alfabet bevindt. Iedereen speelt hetzelfde woord.">
         <link rel="stylesheet" href="/static/game.css">
         <script defer src="https://cdn.jsdelivr.net/npm/alpinejs@3.x.x/dist/cdn.min.js"></script>
     </head>
     <body>
 
-        <script>
+        <div id="container" x-data="">
-            document.addEventListener('alpine:init', () => {
-                Alpine.store('alfagok', {
-                    gameID: 0,
 
-                    loading: false,
+            <a href="/" x-cloak class="title">alfagok</a> <span class="puzzleno">puzzel #<span x-text="$store.alfagok.gameID"></span> • <span id="nextgame"></span> • <span x-text="$store.alfagok.nrGuesses"></span> gokken</span>
 
-                    winTime: null,
+            <div x-cloak class="instructions" x-show="$store.alfagok.guessesBefore.length === 0 && $store.alfagok.guessesAfter.length === 0">
-                    startTime: null,
-
-                    nrGuesses: 0,
-                    guessesBefore: [],
-                    guessesAfter: [],
-
-                    guessValue: '',
-
-                    guessError: '',
-
-                    async getGameID() {
-                        this.loading = true;
-                        console.log('Loading gameID...');
-                        let response = await fetch('/api/game');
-                        let result = await response.json();
-                        console.log(result);
-                        this.loading = false;
-                        if (result.game) {
-                            return this.gameID = result.game;
-                        }
-                    }
-
-                }),
-
-                Alpine.store('darkMode', {
-                    init() {
-                        this.on = window.matchMedia('(prefers-color-scheme: dark)').matches
-                    },
-
-                    on: false,
-
-                    toggle() {
-                        this.on = ! this.on
-                    }
-                })
-
-            })
-        </script>
-
-        <div
-            id="container"
-            x-data=""
-        >
-
-            <a href="/" x-cloak class="title">alfagok</a> <span class="puzzleno">puzzle #<span x-text="$store.alfagok.gameID"></span> • <span id="nextgame"></span></span>
-
-            <div x-cloak x-show="$store.alfagok.guessesBefore.length || $store.alfagok.guessesAfter.length"><br></div>
-
-            <div x-cloak class="instructions" x-else>
                 <p>Raad het woord van de dag. Elke gok geeft een hint over waar het woord zich in het alfabet bevindt.</p>
             </div>
 
-
             <center>
 
-                <ul>
+                <p class="guessesheading" x-cloak x-show="$store.alfagok.guessesBefore.length">Het woord van de dag komt <em>na</em>:</p>
+                <ul class="guessesbefore">
                     <template x-for="item in $store.alfagok.guessesBefore" :key="item">
                         <li x-text="item"></li>
                     </template>
                 </ul>
 
-                <input type="text" x-model="$store.alfagok.guessValue" @keyup.enter="doGuess($store.alfagok.guessValue)">
+                <div x-show="!$store.alfagok.winTime">
+                    <input type="text" autocomplete="new-password" autocorrect="off" x-model="$store.alfagok.guessValue" @keyup.enter="$store.alfagok.doGuess()">
 {#                <p x-cloak>Je huidige gok is: <span x-text="$store.alfagok.guessValue"></span></p>#}
-                <button @click="doGuess($store.alfagok.guessValue)">Doe een gok</button>
+                    <button @click="$store.alfagok.doGuess()">Doe een gok</button>
-                <p x-show="$store.alfagok.guessError" x-text="$store.alfagok.guessError"></p>
+                    <p class="error" x-cloak x-show="$store.alfagok.guessError" x-text="$store.alfagok.guessError"></p>
+                </div>
 
-                <ul>
+                <div x-cloak x-show="$store.alfagok.winTime" class="win">
+                    <h3><b>Je hebt hem! 🎉</b></h3>
+                    <p>Het woord van vandaag was <b x-text="$store.alfagok.guessValue"></b>.</p>
+                    <div id="stats">
+                        <div id="results">
+                            <p><b x-text="$store.alfagok.resultGameID"></b></p>
+                            <p x-text="$store.alfagok.resultGuesses"></p>
+                            <p x-text="$store.alfagok.resultTimeTaken"></p>
+                            <p>🔗 <span style="color:var(--blue)">alfagok.diginaut.net</span></p>
+                        </div>
+                    </div>
+                    <div id="copyresults"></div>
+                    <button class="copy" data-clipboard-target="#results">
+                          Tik om te kopi&euml;ren en te delen ❤️
+                    </button>
+                </div>
+
+                <p class="guessesheading" x-cloak x-show="$store.alfagok.guessesAfter.length">Het woord van de dag komt <em>voor</em>:</p>
+                <ul class="guessesafter">
                     <template x-for="item in $store.alfagok.guessesAfter" :key="item">
                         <li x-text="item"></li>
                     </template>
                 </ul>
 
-
-                <div>
-                    <div x-show="$store.alfagok.winTime" class="win">
-                        <h3><b>Je hebt hem! 🎉</b></h3>
-                        <p>Het woord van vandaag was <b x-text="$store.alfagok.guessValue"></b>.</p>
-                        <div id="stats">
-                            <div id="results">
-                                <p><b x-data="{ message: '🧩 Puzzle #' + $store.alfagok.gameID }" x-text="message"></b></p>
-                                <p x-data="{ message: '🤔 '+ $store.alfagok.nrGuesses + ' gokken' }" x-text="message"></p>
-                                <p x-data="{ message: '⏱️ ' + getFormattedTime($store.alfagok.winTime - $store.alfagok.startTime) }" x-text="message"></p>
-                                <p>🔗 <span style="color:var(--blue)">alfagok.diginaut.net</span></p>
-                            </div>
-                        </div>
-                        <div id="copyresults"></div>
-                        <button class="copy" data-clipboard-target="#results">
-                              Tik om te kopi&euml;ren en te delen ❤️
-                        </button>
-                    </div>
-                </div>
             </center>
 
         </div>
 
-
-        <button x-data @click="$store.darkMode.toggle()">Toggle Dark Mode</button>
-        <div x-data :class="$store.darkMode.on && 'bg-black'">...</div>
-
-
         <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.5.12/clipboard.min.js" rel=preload></script>
         <script src="/static/game.js"></script>
-
+{#
-        <script>
+        <button x-data @click="$store.darkMode.toggle()">Toggle Dark Mode</button>
-            document.addEventListener('alpine:initialized', () => {
+        <div x-data :class="$store.darkMode.on && 'bg-black'">...</div>
-                //Alpine.store('alfagok').gameID = getGameID();
+#}
-                Alpine.store('alfagok').getGameID();
-            })
-        </script>
 
     </body>
 </html>

wordlist/create_list.py

@@ -1,45 +1,92 @@
 import random
 
-MIN_LENGTH = 5
+MIN_LENGTH = 4
 MAX_LENGTH = 10
 
 NUMBER_DAYS = 5 * 365
 
+# Set to True if you want to use the big but difficult OpenTaal list
+USE_OPENTAAL = False
+
+with open('wikiwoordenboek_basiswoorden.lst', 'r', encoding='utf-8') as wordfile:
+    wikiwoorden_words = wordfile.readlines()
+    print(f'wikiwoorden basic list contains {len(wikiwoorden_words)} words')
+
 with open('basiswoorden-gekeurd.txt', 'r', encoding='utf-8') as wordfile:
-    all_words = wordfile.readlines()
+    basis_words = wordfile.readlines()
-    print(f'original list contains {len(all_words)} words')
+    print(f'opentaal basic list contains {len(basis_words)} words')
 
-    dictionary_list = []
+with open('flexies-ongekeurd.txt', 'r', encoding='utf-8') as wordfile:
-    result_list = []
+    # Vervoegingen and such, see https://nl.wikipedia.org/wiki/Flexie_(taalkunde)
-    for word in all_words:
+    flexies_words = wordfile.readlines()
-        word = word.strip()
+    print(f'flexies list contains {len(flexies_words)} words')
-        if word.isalpha() and word.lower() == word:
-            # Word is valid for our dictionary
-            dictionary_list.append(f'{word}\n')
-        if word.isalpha() and word.lower() == word and len(word) > MIN_LENGTH and len(word) <= MAX_LENGTH:
-            # Word is 'fit' for our game
-            result_list.append(f'{word}\n')
 
-    # print(result_list)
+with open('/usr/share/dict/american-english', 'r', encoding='utf-8') as wordfile:
-    print(f'words filtered: {len(result_list)} with length > {MIN_LENGTH} and <= {MAX_LENGTH}')
+    # English words we want to filter from the list; don't really care if there's accidental overlap with Dutch words
-    print(f'words in dictionary: {len(dictionary_list)}')
+    english_words = wordfile.readlines()
+    print(f'english list contains {len(english_words)} words')
 
-    with open('filtered.txt', 'w', encoding='utf-8') as f:
+print()
-        f.writelines(result_list)
+print('merging and filtering...')
+print()
 
-    with open('dictionary.txt', 'w', encoding='utf-8') as f:
+all_words_count = 0
-        f.writelines(dictionary_list)
+dictionary_list = []
+result_list = []
+for word in wikiwoorden_words + basis_words + flexies_words:
+    all_words_count += 1
+    word = word.strip()
+    if word.isalpha() and word.lower() == word:
+        # Word is valid for our dictionary
+        dictionary_list.append(f'{word}\n')
 
-    selection_list = []
+# Deduplicate dictionary
+dictionary_list = sorted(list(set(dictionary_list)), key=str.casefold)
 
-    # Randomly select words for each day
+if USE_OPENTAAL:
-    while len(selection_list) < NUMBER_DAYS:
+    # Use basis_words if you want to use the big but difficult OpenTaal list
-        # Use index - 1 because lists start at index 0
+    source_words = basis_words
-        word_index = random.randrange(0, len(result_list) - 1)
+else:
-        selection_list.append(result_list[word_index])
+    source_words = wikiwoorden_words
 
-    # Save the result
+for word in source_words:
-    with open('word_of_the_day.txt', 'w', encoding='utf-8') as f:
+    word = word.strip()
-        f.writelines(selection_list)
+    if word.isalpha() and word.lower() == word and len(word) >= MIN_LENGTH and len(word) <= MAX_LENGTH:
+        # Word is 'fit' for our game
+        result_list.append(f'{word}\n')
 
-    print(f'done writing {len(selection_list)} random words, enjoy!')
+if USE_OPENTAAL:
+    nl_set = set(result_list)
+    en_set = set(english_words)
+
+    # Only keep the words that are not found in the English set
+    filtered_set = nl_set.difference(en_set)
+    filtered_list = sorted(list(filtered_set), key=str.casefold)
+else:
+    filtered_list = sorted(list(wikiwoorden_words), key=str.casefold)
+
+print(f'words total: {all_words_count}')
+print(f'words in dictionary: {len(dictionary_list)}')
+print(f'words initially filtered: {len(result_list)} with length >= {MIN_LENGTH} and <= {MAX_LENGTH}')
+if USE_OPENTAAL:
+    print(f'words after filtering english: {len(filtered_list)}')
+
+with open('filtered.txt', 'w', encoding='utf-8') as f:
+    f.writelines(filtered_list)
+
+with open('dictionary.txt', 'w', encoding='utf-8') as f:
+    f.writelines(dictionary_list)
+
+selection_list = []
+
+# Randomly select words for each day
+while len(selection_list) < NUMBER_DAYS:
+    # Use index - 1 because lists start at index 0
+    word_index = random.randrange(0, len(filtered_list) - 1)
+    selection_list.append(filtered_list[word_index])
+
+# Save the result
+with open('word_of_the_day.txt', 'w', encoding='utf-8') as f:
+    f.writelines(selection_list)
+
+print(f'done writing {len(selection_list)} random words, enjoy!')