Dev Environment

Setup

• Fork and clone the repository.
• Copy the config.example.php file to config.php in /inc/ or set environment variables as defined in config.env.php.
• Contact a current maintainer for server/database configs.
• If you wish to see images locally, you will also need S3 credentials, either supply your own or reach out.

Run Locally

In order to run locally youre going to need docker.

docker build -t schedulemaker .
docker run --rm -i -t -p 5000:8080 --name=schedulemaker schedulemaker

You can replace 5000 with whatever port you wish to connect locally to. Then visit http://localhost:5000 in a browser.

Development

• To build js files run npm run-script build.
• Increment the version number in package.json after updating js/css files or ensure all cache cleared.
  • Make sure you increment at least the patch number in any PRs that touch Javascript/CSS.
• If you get an error with JS/CSS not loading, check your config file.

Maintainers

Current Maintainers

• Devin Matte (@devinmatte)

Past Maintainers

• Ben Grawi (@bgrawi)
• Benjamin Russell (@benrr101)