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.
cli/– Useful scripts to be called from the command linedocs/– Documentation (you are here!)fixtures/– Repository of our fixture definitionslib/– Reusable modules used in the projectfixture-features/– Fixture features, special fixture characteristics used to determine a set of test fixturesmodel/– 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 formatsresources/– Resources (e.g. gobos) that fixtures can useschemas/– Schemas for the fixture definitionsserver/– Load balancer config and auto-deploy script for everyone interestedtests/– Unit tests, many of them run automatically in GitHub Actionsgithub/– 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.
Make sure you have these dependencies installed:
git- Node.js
Then run
git clone https://github.com/OpenLightingProject/open-fixture-library.git
cd open-fixture-library
npm install
npm run buildContinue with UI docs.
Make sure you have these dependencies installed:
- Git
- Node.js
- windows-build-tools
- Open a Terminal as Administrator and run
npm install --global windows-build-tools --vs2015
- Open a Terminal as Administrator and run
Choose a project path that only contains ASCII characters and no spaces. Open a Terminal and run
git clone https://github.com/OpenLightingProject/open-fixture-library.git
cd open-fixture-library
npm install
npm run buildContinue with UI docs.
Please see CONTRIBUTING.md.