Developer Guide

Step-by-step coding tutorials for extending FreeBCI DAQ.

#	Tutorial	What you'll build
1	Environment Setup	Clone → npm install → npm run dev → run tests
2	Architecture Tour	Follow one sample through the entire pipeline
3	Add a Panel	New React component → register in App.tsx → add i18n
4	Add an Algorithm	Write a formula → hook into the analyzer → display on a chart
5	Serial Protocol	EEGRST / EEGCFG / SW,START sequencing, binary parser internals
6	State Management	Zustand vs. refs boundary, observer bus pattern, waveform rendering
7	IIR Filter Pipeline	Butterworth filter implementation, rebuild triggers, window clearing
8	AI Pipeline	Five-band recording, IndexedDB schema, LLM call flow
9	i18n & Theming	Add translation keys, Tailwind v4 theme variables, Card primitives
10	Testing	Vitest patterns, fake-indexeddb, mocking Web Serial
11	Build & Deploy	vite build, dist/ static hosting, HTTPS requirement

Reference

Doc	Covers
Developer Reference	Architecture overview, directory map, coding conventions
Data Pipeline	Full pipeline diagram and component relationships
Configuration	VITE_* environment variables and tuning parameters

Prerequisites

Before starting:

• Node.js 18+ installed
• Chrome or Edge for Web Serial testing
• The project cloned and npm install completed
• Familiarity with React, TypeScript, and Vite

Start with Environment Setup if you haven't already.