Getting started ¶

The following commands should be run in a terminal program like bash.

Clone the repository ¶

git clone https://github.com/cal-itp/eligibility-api.git

This repository comes with a VS Code Remote Containers configuration file.

Once you clone the repository locally, simply open it within VS Code, which will prompt you to re-open the repository within the Remote Container.

When running the Devcontainer, the server is automatically started.

Otherwise, manually start the docs container with

docker compose up docs

The site is served from http://localhost at a port dynamically assigned by Docker. See Docker dynamic ports for more information.

The website is automatically rebuilt as changes are made to docs/ files.