OED Developer Documentation

Overview

This information is for developers of the OED software so this information is not usually of interest to a general user.

The update to the Redux Toolkit (RTK) is not yet reflected in the documentation. As a result, some information may be out of date.

Developer documentation
Information
Overview: Lists developer documentation pages.
Starting
Developer First Steps: How to begin coding development with OED.
Contributor License Agreement: Describes the CLA that all contributors must sign.
Creating Pull Requests: Describes how to request your work be integrated into the OED project.
Test Data: Describes how to load sample data into your OED system.
Work Selection: Describes some thoughts on choosing work within the OED project.
Codebase Info
Learn OED Technology: Describes resources to learn about the technologies used in OED.
npm scripts: Information on npm commands that are available for a wide array of actions.
Technology Overview: Overview of technology usage that currently describes how front-end code becomes our web-based app.
Further Details
Code Organization: Describes the directory structure and meaning of files in the OED code base.
Developer Details: More detailed information that developers may find useful.
Documentation Expectations: Describes our desires in documenting code and doing imports.
Environment Variables: Information on environment variables used in OED.
Full Install Output: Shows the terminal output of building OED for the first time.
No npm/DB Install Output: Shows the terminal output of building OED where there the npm install is skipped.
Test Code: Information on how to use and include test code in OED.
Version Release
Releasing OED: Discusses how to create an OED release.