This is built using KeystoneJS.

On first checkout you will need to init the git submodule for the Society-Documentation folder in /external. This can be initialised with the git command git submodule update --init --recursive.

To get Keystone running, you at least need a MongoDB instance running, and you will need to run npm install in the project folder to get any dependancies. The development server can then be initiated with node keystone.

In addition to the services configuration options, the following optional environment variables are used:

MAINTENANCE_ENABLED

If this is 'true', the site is put into maintenance mode, with only the maintenance placeholder page accessible. Administrators are still able to access the site normally.

MAINTENANCE_MSG

The message to be shown on the maintenance page.

The sites uses some external services. These are setup to use dummy configuration values by default. To use them, you need to set their config options either as environment variables or in a .env file in the root of the repo.

Cloudinary is used for image hosting an manipulation.

CLOUDINARY_URL=cloudinary://user:key@domain

Mandrill is used for sending email.

MANDRILL_API_KEY=key
MANDRILL_USERNAME=user