Skip to main content

Developer Docs

Welcome to the Apache Superset Developer Docs - your comprehensive resource for contributing to and extending Apache Superset.

Quick Startโ€‹

New Contributorsโ€‹

Extension Developmentโ€‹

Documentation Sectionsโ€‹

Extensionsโ€‹

Learn how to build powerful extensions that enhance Superset's capabilities. This section covers the extension architecture, development patterns, and deployment strategies. You'll find comprehensive guides on creating frontend contributions, managing extension lifecycles, and understanding security implications.

Testingโ€‹

Comprehensive testing strategies for Superset development. This section covers frontend testing with Jest and React Testing Library, backend testing with pytest, end-to-end testing with Playwright, and CI/CD pipeline best practices.

Contributing to Supersetโ€‹

Everything you need to contribute to the Apache Superset project. This section includes community guidelines, development environment setup, pull request processes, code review workflows, issue reporting guidelines, and Apache release procedures. You'll also find style guidelines for both frontend and backend development.

Development Resourcesโ€‹

Prerequisitesโ€‹

  • Python: 3.9, 3.10, or 3.11
  • Node.js: 18.x or 20.x
  • npm: 9.x or 10.x
  • Git: Basic understanding
  • React/TypeScript: For frontend development
  • Flask/SQLAlchemy: For backend development

Key Technologiesโ€‹

  • Frontend: React, TypeScript, Ant Design, Redux
  • Backend: Flask, SQLAlchemy, Celery, Redis
  • Build Tools: Webpack, Babel, npm/yarn
  • Testing: Jest, Pytest, Playwright
  • CI/CD: GitHub Actions, pre-commit

Communityโ€‹

Get Helpโ€‹

Contributeโ€‹

Additional Resourcesโ€‹

External Documentationโ€‹

Important Filesโ€‹

Where to Start?โ€‹

I want to contribute code

  1. Set up development environment
  2. Find a good first issue
  3. Submit your first PR

I want to build an extension

  1. Start with Quick Start
  2. Learn extension development
  3. Explore architecture

I found a bug

  1. Search existing issues
  2. Report the bug
  3. Submit a fix

I need help

  1. Check the FAQ
  2. Ask in Slack
  3. Start a discussion

Welcome to the Apache Superset community! We're excited to have you contribute.