Getting Started Overview
Onboarding path, UXDL stack map, and where to go next.
Welcome to UXDL Docs. This section gets you from zero to a working local environment and your first pull request.
Onboarding path
Recommended sequence
Request accounts and access — Onboarding Checklist.
Install the shared toolchain — Local Development Setup.
Configure env files — Environment Variables.
- Set up Cursor/VS Code — IDE & Tooling.
Learn how code ships — Development Workflow (Alpha → Beta → Prod).
UXDL stack at a glance
| Area | Technologies | Docs |
|---|---|---|
| Web apps | React, Next.js, Angular | Frontend |
| Mobile | React Native | React Native setup |
| API | Node.js (Express) · Python (FastAPI) | Backend |
| Auth | AWS Cognito | Cognito · API Auth |
| Databases | PostgreSQL, MongoDB, Supabase | Data Layer |
| Realtime | Socket.io | Socket.io |
| Storage | AWS S3, CloudFront | AWS S3 |
| Push | Firebase Cloud Messaging | FCM |
| AWS SES, SendGrid, Brevo | ||
| Deploy | Docker, AWS ECS | Docker · ECS |
| Observability | OpenTelemetry, Sentry, Axiom | Observability |
| Testing | Playwright | Testing |
What you'll run locally
Most engineers run at least two processes during development:
| Process | Default port | Repo example |
|---|---|---|
| UXDL Docs (this site) | 3010 (PORT env) | uxdl-documentation |
| Frontend (Next.js) | 3000 | uxdl-web |
| Backend API (Express) | 4000 | uxdl-api |
Optional local services via Docker: PostgreSQL, MongoDB. See Local Development Setup.
Environments
Code moves through three environments before reaching customers:
Details: Environments.
Need help?
- Build or CI failing — Build Failures
- Auth or env issues locally — Common Issues
- Slack —
#engineeringand#engineering-support