Read Contributing to IETF Tools projects.
This website uses the Wagtail CMS.
See the installation instructions
Wagtail is based on Django, and there are many tests, in each app, typically named tests.py or tests/test_*.py, to test templates and business logic. These verify that the pages render without error and that they contain the expected values.
The testsuite uses pytest and pytest-django. You can run the testsuite locally:
pytestThis project uses Bootstrap. The exact version is specified in the package.json file.
Please adhere to standard Bootstrap practices where possible rather than adding bespoke code, so that future developers can benefit from Boostrap docs and the broader ecosystem.
See the installation instructions to get the website running on your local machine.
If you need to inspect the generated files outside of Docker, you can run these commands:
Install NVM and Yarn and then run these commands from the repo directory,
nvm install
nvm useThis will use NVM to install the correct version of Node for this project, and switch to using that version of Node.
yarnRunning yarn without any arguments is an alias for yarn install. This will install the packages from package.json.
yarn buildThis will run Webpack and compile the source files at ietf/static_src. The yarn build command runs a development build without minification and optimisation (useful for debugging), whereas yarn dist will run a production build (with minification).
Note that ietf/static_src will compile HTML templates into ietf/static, and this includes Wagtail templates such as base.html. Webpack will add CSS and JS tags.
This command requires a running website which may be your local development site.
yarn test:accessibility http://localhost:8001Replace "http://localhost:8001" with the URL of your running website.
See the deployment section