Skip to content
/ toadua Public

The online collaborative dictionary for the constructed language Toaq.

License

Notifications You must be signed in to change notification settings

toaq/toadua

This branch is up to date with main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

4e4da0e · Jan 17, 2025
Jul 15, 2024
Nov 3, 2023
Jan 5, 2025
Jan 9, 2025
Nov 22, 2023
Jan 6, 2025
Jan 9, 2025
Jul 10, 2023
Feb 15, 2022
Dec 28, 2022
Oct 25, 2023
Jan 2, 2023
Jul 24, 2023
Jan 2, 2023
Aug 3, 2024
Aug 4, 2024
Jul 16, 2024
Jul 16, 2024
Jul 16, 2024

Repository files navigation

Toadua

Toadua is the/an online collaborative dictionary for the Toaq constructed language. It is also currently being remodelled to suit general usage. You can visit the current instance at https://toadua.uakci.pl.

You can also use the public API exposed at https://toadua.uakci.pl/api (read the docs, too).

Please note: Currently in the process of cleaning up, removing the unprofessional bits, and other groundbreaking changes. Please take the information below with a pinch of salt. Sorry.

Installing and running

Locally (good for dev env)

  • Install Node.js version ≥16 (skip this step if you're using nix with direnv).
  • Frontend:
    • Cd into the frontend directory and run npm install there.
    • npm run build will create a webpack build.
  • Backend:
    • Run npm install in the cloned repository to get the dependencies.
    • Run npm run build to compile the TypeScript sources.
    • npm run start should now work out of the box. Navigate to http://localhost:29138/ in your browser.

With Nix (good for verifying build correctness)

  • Run nix run . -- -d . to build the service and run it right away.
  • Run nix build to do a full build. You may then inspect the contents of result/.

HTTP security warning

Please note that the server is set up to run on port 29138 (by default) and serve HTTP; however, you’re not supposed to expose the HTTP website, but rather embed it in some other webserver of your choice which supports HTTPS (and tunnelling). I have rewriting the code for out-of-the-box HTTPS-ness on my to-do list.