WEEEHire 2.0

Manage applications to the team.

Local development

With Docker

The Docker container is still a work in progress. If you encounter issues use the containerless version instead.

Run ./launch.sh in the main directory of the repository to run the server with docker-compose. The script accepts one optional parameter:

• d or detach to run in detached mode (remember to run docker-compose down when you are done).
• p or php to only follow logs coming from php and not from the web server (press CTRL+C to terminate the server).
• nothing (default) to run the containers in the foreground and follow all logs (press CTRL+C to terminate the server).

Once launched the application is available at http://localhost:8082

To update the database schema run docker-compose exec -T app php /var/www/html/database/update-db.php.

Without containers

You will need:

• PHP (any recent version) with SQLite extension enabled
• Composer
• The sqlite3 executable to create an empty database
• gettetxt (for the msgfmt command)

Then, run these commands:

sqlite3 database/weeehire.db < database/database.sql
sqlite3 database/weeehire.db < database/example-data.sql  # If you want some example data
cp config/config-example.php config/config.php
nano config/config.php  # Optional, the defaults are good for a test instance but not for production
msgfmt resources/locale/en-US/LC_MESSAGES/messages.po --output-file=resources/locale/en-US/LC_MESSAGES/messages.mo
composer install
php -S [::]:8777 -t public

Done. Browse to [::]:8777 and have fun.

You do not need to configure the SSO part, neither LDAP, neither sendmail, nor to install APCu: these are required in production only.

In fact, if TEST_MODE is true in config.php:

• Emails will not be sent, they are printed to stderr
• Authentication is bypassed, access [::]:8777/candidates.php directly
• No LDAP connections are made, example data is returned instead
• APCu is not used at all

APCu is optional but strongly recommended in production. WEEEHire will print some warnings to stderr if APCu is not enabled.

Translations

# Generate the master .pot file
xgettext -k__ -k_ngettext:1,2 --from-code utf-8 templates/*.php -o messages.pot

# Merge it into other .po files (en-US only, right now)
msgmerge --update resources/locale/en-US/LC_MESSAGES/messages.po messages.pot

# Translate strings, e.g. with
lokalize resources/locale/en-US/LC_MESSAGES/messages.po &

# Create the .mo file
msgfmt resources/locale/en-US/LC_MESSAGES/messages.po --output-file=resources/locale/en-US/LC_MESSAGES/messages.mo

And done.

Production deployment

Basically the same as development:

sqlite3 database/weeehire.db < database/database.sql
cp config/config-example.php config/config.php
nano config/config.php
msgfmt resources/locale/en-US/LC_MESSAGES/messages.po --output-file=resources/locale/en-US/LC_MESSAGES/messages.mo
chown o-r database/weeehire.db  # Optional, prevent other users from reading the database
composer install --no-dev --optimize-autoloader  # The optimization is not required but a nice touch

and a real web server is needed. The root directory is public, no need to serve files outside that directory.