Developer Guide

Codebase, tooling, and plugin development workflow.

Overview

The Developer Guide provides a technical roadmap for contributors and plugin authors. It details the project structure, local environment setup, and the interaction between the state management layer and core cryptographic services.

This section focuses on implementation details, API surfaces, and development workflows. While the Architecture section defines the conceptual design and threat model, this guide provides the practical instructions necessary to extend the application or contribute to its core logic.

Reading Order

To begin developing for WebStray Authenticator, it is recommended to follow this sequence:

  1. Development Environment – Tooling, setup process, and development workflow.
  2. Project Structure – Project structure, architectural layers, and module ownership.
  3. Internal Services – Core utilities for database management, cryptography, and data portability.
  4. State Layer – Zustand stores and their functional roles.
  5. Plugin SDK – Technical reference for components and core API.
  6. Plugin Lifecycle – Discovery, slot registration, and teardown processes.
  7. Plugin Security – Trust model, data handling rules, and UI/UX boundaries.
  8. First Plugin – Building your first plugin.
  9. Testing & Quality – Manual verification matrix and pre-release checklist.

Summary

The development workflow combines standard web tooling with the NW.js runtime. By adhering to the established modular structure and utilizing the provided SDK, developers can build secure, consistent features that respect the application's core security boundaries.