README.md

Documentation Overview

This is the developer documentation for the Open Fixture Library. Please follow links in the folder structure below to get more information on a specific topic.

Repository folder structure

• cli/ – Useful scripts to be called from the command line
• docs/ – Documentation (you are here!)
• fixtures/ – Repository of our fixture definitions
• lib/ – Reusable modules used in the project
  • fixture-features/ – Fixture features, special fixture characteristics used to determine a set of test fixtures
  • model/ – Classes of the fixture model that help ease processing fixture data (see the model API reference)
• plugins/ – Plugins for export / import to / from other software's fixture formats
• resources/ – Resources (e.g. gobos) that fixtures can use
• schemas/ – Schemas for the fixture definitions
• server/ – Load balancer config and auto-deploy script for everyone interested
• tests/ – Unit tests, much of them run automatically in GitHub with Travis
  • github/ – Special kind of tests which shouldn't be called manually and create comments in GitHub pull requests
• ui/ – Everything related to the UI / Website (see docs there for subfolders)
• tmp/ – Temporary files autogenerated by tests. Safe to delete and not indexed by Git.

Contributing

Please see CONTRIBUTING.md.

Environment variables

See environment-variables.md.