m4rch3n1ng / blictionary

blictionary

entries

entries are stored as json files in a directory called entries
the json file names should follow the convention [id].json, with [id] following the regex of /^[1-9][0-9]*$
be aware: the directory with the entries must be in the directory of the terminal when executing

you can look at the type definition for an Entry here.

build

you need to have node.js v16 or above and npm v8 or above

to initialize the project download it and run

$ npm install

to build/compile the project run

$ npm run build

you can run the project by either running

$ node build/

or

$ cd build/
$ node .

be aware: the directory with the entries must be in the directory of the terminal when executing

misc

credit for the (temporary) icon goes to reksi! thank you!