Readme.md

ParseTrainer

A simple app to practice Hebrew verbs.

Live version

parse.hebrewtools.org

Installation

$ git clone https://github.com/HebrewTools/ParseTrainer.git
$ cd ParseTrainer
$ composer install
$ npm ci
$ npm run dev

Configuration

Copy the .env.example file in the root directory to .env and customize it.

Install npm packages:

$ npm install

When developing, the following command can be used to automatically rebuild static resources (JS, CSS, etc.) when source files change:

$ npm run watch

Docker Compose

To initialize the database:

$ docker compose run --rm app bash -c 'composer install && php artisan migrate --seed'

To generate an application key:

$ docker compose run --rm app php artisan key:generate

Then to run the server:

$ docker compose up -d

Local

First, create a MySQL database and a user that can connect to it.

Then run:

$ php artisan key:generate
$ php artisan migrate --seed

You can now test the application with artisan's built-in web server:

$ php artisan serve

Alternatively, you can configure PHP through Nginx.

Nginx

You need to enable PHP and redirect everything to server.php. Configuration on the root of a site is straightforward:

server {
    listen [::]:80;
    server_name myhostname;
    root /.../ParseTrainer;
    index index.php index.html index.htm;
    charset utf-8;

    location / {
        autoindex off;
        try_files $uri $uri/ /server.php$is_args$query_string;
    }

    location ~ \.php$ {
        # whatever you do to make PHP work
    }

    location ~ /\. {
        deny all;
    }
}

If serving from a different path, we need to enforce trailing slashes and do some special things. This configures Nginx to serve the application from /ParseTrainer/:

server {
    listen [::]:80;
    server_name myhostname;
    root /...;
    index index.php index.html index.htm;
    charset utf-8;

    rewrite ^([^.]*[^/])$ $1/ permanent;

    location ~ ^/ParseTrainer/(.*)\.php$ {
        try_files $uri $uri/ /ParseTrainer/server.php$is_args$query_string;

        # whatever you do to make PHP work
    }

    rewrite /ParseTrainer/?$ /ParseTrainer/public/index.php;
    location /ParseTrainer {
        try_files $uri $uri/ /ParseTrainer/server.php$is_args$query_string;
    }

    location / {
        autoindex off;
    }

    location ~ /\. {
        deny all;
    }
}

License

Copyright 2015–present Camil Staps. Licensed under GPL v3.0, see the LICENSE file.

This project uses the EzraSIL font which is licensed under the Open Font License.