> For the complete documentation index, see [llms.txt](https://docs.fractalworks.io/joule/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fractalworks.io/joule/developer-guides.md).

# DEVELOPER GUIDES

- [Setting up developer environment](https://docs.fractalworks.io/joule/developer-guides/setting-up-developer-environment.md): Setting up Joule environment for seamless data processing applications
- [Environment setup](https://docs.fractalworks.io/joule/developer-guides/setting-up-developer-environment/environment-setup.md): Detailed prerequisites for the environment
- [Build and deploy](https://docs.fractalworks.io/joule/developer-guides/setting-up-developer-environment/build-and-deploy.md): Define components, build, test, package, deploy project
- [Install Joule](https://docs.fractalworks.io/joule/developer-guides/setting-up-developer-environment/install-joule.md): Joule Docker images, installation, custom builds and examples
- [Install Docker demo environment](https://docs.fractalworks.io/joule/developer-guides/setting-up-developer-environment/install-joule/install-docker-demo-environment.md)
- [Install with Docker](https://docs.fractalworks.io/joule/developer-guides/setting-up-developer-environment/install-joule/install-with-docker.md): Use prebuilt images for quick setup
- [Install from source](https://docs.fractalworks.io/joule/developer-guides/setting-up-developer-environment/install-joule/install-from-source.md): Install Joule from source, connectors, and processors locally
- [Install Joule examples](https://docs.fractalworks.io/joule/developer-guides/setting-up-developer-environment/install-joule/install-joule-examples.md): Clone Joule examples from GitLab, build, explore updates.
- [Joulectl CLI](https://docs.fractalworks.io/joule/developer-guides/joulectl-cli.md): Use Joulectl to deploy and manage use cases within the Joule platform
- [API Endpoints](https://docs.fractalworks.io/joule/developer-guides/api-endpoints.md): Joule REST APIs enables easy custom data processing and integration
- [Mangement API](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/mangement-api.md): Manages applications and integrations, providing endpoints for deployment, pipeline management, connector registration and contextual data sources
- [Use case](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/mangement-api/use-case.md): Deploy, pause, resume and undeploy use cases
- [Pipelines](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/mangement-api/pipelines.md): Register, list, detail and unregister stream processing pipelines
- [Data connectors](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/mangement-api/data-connectors.md): Register, list, detail and unregister data sources and sinks
- [Contextual data](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/mangement-api/contextual-data.md): Register, list, detail and unregister contextual data sources
- [Data access API](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/data-access-api.md): Enables data interactions, allowing for querying, publishing and consuming data events
- [Query](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/data-access-api/query.md): Fetch, export, delete and subscribe to data
- [Upload](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/data-access-api/upload.md): Upload files and stream events in to a running Joule process
- [WebSocket](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/data-access-api/websocket.md): Subscribe to events from a WebSocket
- [SQL support](https://docs.fractalworks.io/joule/developer-guides/api-endpoints/sql-support.md): This is an incubating feature which is constantly being refined and extended
- [Builder SDK](https://docs.fractalworks.io/joule/developer-guides/builder-sdk.md): Joule SDK APIs enable connectors, processing, analytics and transformations
- [Connector API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/connector-api.md): Connectors are key to enable Joule to perform use cases. Given the importance of Connectors, an API has been provided to enable developers to build and extend the capabilities of the platform.
- [Sources](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/connector-api/sources.md)
- [StreamEventParser API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/connector-api/sources/streameventparser-api.md): Custom parser converts a domain Quote object into an internal Joule StreamEvent
- [Sinks](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/connector-api/sinks.md)
- [CustomTransformer API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/connector-api/sinks/customtransformer-api.md): Custom parser converts an internal Joule StreamEvent into a domain object
- [Processor API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/processor-api.md): Processors form the core of the joule platform. Given the importance of Processors, an API has been provided to enable developers to build and extend the capabilities of the platform.
- [Analytics API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/analytics-api.md): Analytics form the core of the platform to drive insight to value. Joule provides various methods to define and leverage analytics within a streaming context
- [Create custom metrics](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/analytics-api/create-custom-metrics.md): Add pre-computed metrics to custom processors that drive advanced analytic use cases
- [Define analytics](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/analytics-api/define-analytics.md): Create custom analytic functions for window processing that drive advanced analytic use cases
- [Windows API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/analytics-api/windows-api.md): Customise and extend Joule analytics capability using the Windows API
- [SQL queries](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/analytics-api/sql-queries.md): Leverage the power of ANSI SQL within custom processors using the in-memory database
- [Transformation API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/transformation-api.md)
- [Obfuscation API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/transformation-api/obfuscation-api.md): Use the Obfuscation API to meet your requirements
- [FieldTokenizer API](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/transformation-api/fieldtokenizer-api.md)
- [File processing](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/file-processing.md): Joule provides utility classes to load large files efficiently
- [Data types](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/data-types.md): Key data types available within the Joule platform
- [StreamEvent](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/data-types/streamevent.md): StreamEvent enables flexible, efficient event-driven data processing in Joule
- [ReferenceDataObject](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/data-types/referencedataobject.md): ReferenceDataObject stores, queries, and manages contextual reference data
- [GeoNode](https://docs.fractalworks.io/joule/developer-guides/builder-sdk/data-types/geonode.md): Geospatial data structure for location-based spatial entity analysis
- [System configuration](https://docs.fractalworks.io/joule/developer-guides/system-configuration.md)
- [System properties](https://docs.fractalworks.io/joule/developer-guides/system-configuration/system-properties.md): Configure and enable core Joule features based on deployment needs
- [Memory configuration](https://docs.fractalworks.io/joule/developer-guides/system-configuration/memory-configuration.md): Fine tune JVM memory requirements to event consumption and processing
- [Restarting Joule processes](https://docs.fractalworks.io/joule/developer-guides/system-configuration/restarting-joule-processes.md)