petermarkley / tollerus
A conlang dictionary Laravel package - build, browse, and publish your conlang's lexical data online
Requires
- illuminate/support: ^12.0
- livewire/livewire: ^3.6
- masterminds/html5: ^2.10
Requires (Dev)
None
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
A conlang dictionary Laravel package - build, browse, and publish your conlang's lexical data online. Official website
| YouTube Demo |
|---|
Note
Made for use on https://eithalica.world. Named after good ol' "Tollers," the 20th-century conlanger legend.
I'm a one-man dev team. If you like this software, please consider supporting me!
Installation
With example app
I made a Tollerus example app for easier installation.
All you need is Git and Docker, then:
git clone https://github.com/petermarkley/tollerus-example-app
cd tollerus-example-app
cp .env.example .env
docker run --rm -v $(pwd):/app -w /app composer install
./vendor/bin/sail up -d
./vendor/bin/sail artisan key:generate
./vendor/bin/sail artisan migrate --seed
./vendor/bin/sail npm install
./vendor/bin/sail npm run build
That's it! You can now visit localhost:8080/tollerus/admin in your browser (or whatever port is set by APP_PORT in your .env file).
Log in with:
- Email
test@example.com - Password
password
Happy conlanging!
Without example app
Tollerus is a Laravel package and requires a host app. If you don't have one, you'll need to create one. If you want to do that without using the Tollerus example app, see here.
Once you have a Laravel app:
composer require petermarkley/tollerus
php artisan tollerus:install
php artisan migrate
Running Tests
Tollerus was written for MariaDB/MySQL and is not compatible with SQLite. Consequently, to run tests you must provide a working MySQL instance for Testbench to connect to.
First, copy the example phpunit.xml:
cp phpunit.xml.dist phpunit.xml
Then put your SQL connection details in the appropriate lines of phpunit.xml:
<env name="DB_DATABASE" value="tollerus_test"/>
<env name="DB_USERNAME" value="your_user"/>
<env name="DB_PASSWORD" value="your_password"/>
Important
The tollerus_test database (or whatever you enter) must exist, and should be disposable because Pest may delete/overwrite its contents.
Once the connection is configured, install dependencies and run the tests.
composer install
./vendor/bin/pest
Since Tollerus is a Laravel package, there is no php artisan. You must call the Pest binary directly, as shown here.
