]> git.r.bdr.sh - rbdr/prompt/blob - README.md
Add the CI deployment files
[rbdr/prompt] / README.md
1 # Prompt
2
3 Drawing prompts delivered to YOUR door.
4
5 ## Regenerating data
6
7 This poject is based on [wordnet][wordnet] data, which is provided
8 as `.tab` files.
9
10 This repo provides a script `wordnet_to_json`, that converts the
11 tab to easy to use JSON files.
12
13 You can run it by calling `npm run wordnet_to_json <source_tab> <lang> <data_dir>`
14
15 The convention is to use 2 letter codes for language (eg. `en` or `es`) and
16 store it in `static/data` so to load spanish data files you would call:
17
18 ```
19 npm run wordnet_to_json path/to/wn-data-spa.tab static/data/es
20 ```
21
22 If you're running into errors and the default error messages aren't helping,
23 you can enable more detailed debug data by setting `NODE_DEBUG=wordnet_to_json`
24
25 ## Building
26
27 Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then:
28
29 ```bash
30 npm run build
31 ```
32
33 > You can preview the built app with `npm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.
34
35 [wordnet]: http://compling.hss.ntu.edu.sg/omw/