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, many of them run automatically in GitHub Actions
  • 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.

Local installation

Linux / macOS

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 build

Continue with UI docs.

Windows

Make sure you have these dependencies installed:

• Git
• Node.js
  • On the Tools for Native Modules page, activate the checkbox Automatically install the necessary tools. [...]

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 build

Continue with UI docs.

Dev Container

Make sure you have these dependencies installed:

• Git
• Docker Desktop
  • Windows-only: WSL2 + WSL integration in Docker Desktop enabled
• VS Code
  • Dev Containers extension installed
  • Windows-only: WSL extension installed

Open a terminal and run:

git clone https://github.com/OpenLightingProject/open-fixture-library.git
code open-fixture-library

In VS Code, select F1 -> Dev Containers: Reopen in Container, which reopens the repository in a container and runs npm install.

Open a terminal in VS Code and run:

npm run build

Continue with UI docs.

Contributing

Please see CONTRIBUTING.md.

Environment variables

See environment-variables.md.