A service for checking URLs are safe.

• Git

• pyenv Follow the instructions in the pyenv README to install it. The Homebrew method works best on macOS.

• Docker. Follow the instructions on the Docker website to install Docker.

git clone https://github.com/hypothesis/checkmate.git

This will download the code into a checkmate directory in your current working directory. You need to be in the checkmate directory from the remainder of the installation process:

cd checkmate

Start the services that Checkmate requires using Docker Compose:

make services

Create the database contents and environment variable settings needed to get Checkmate working:

make devdata

make dev

The first time you run make dev it might take a while to start because it'll need to install the application dependencies and build the assets.

This will start the app on https://localhost:9099.

That's it! You’ve finished setting up your Checkmate development environment. Run make help to see all the commands that are available for running the tests, linting, code formatting, etc.