mayankmahavar1mg

Catalyst

Catalyst is a React framework for building performant web apps and universal apps for Android and iOS. It provides server-side rendering, route-level data fetching, app shell primitives, styling conventions, and native WebView packaging tools.

Quick Start

Create a new Catalyst app with:

npx create-catalyst-app@latest

Then start the generated app:

cd <your-app>
npm run start

The development server starts at http://localhost:3005.

Documentation

Read the full documentation at catalyst.1mg.com.

Useful starting points:

• Getting Started
• First Catalyst App
• Universal App Setup

Packages

• catalyst-core: the framework package used by Catalyst applications.
• create-catalyst-app: the CLI for scaffolding new Catalyst apps.

Requirements

• Node.js 20.4.0 or later for generated Catalyst apps.
• macOS or Linux for local development.

Repository

This repository is a monorepo containing the framework package, scaffolding CLI, docs app, and internal test fixture.

• packages/catalyst-core: framework package
• packages/create-catalyst-app: CLI and scaffold templates
• apps/catalyst-core-test: standalone fixture app used to test catalyst-core
• docs: Catalyst documentation app

Contributing

Install dependencies and create local docs config before running build/test commands:

npm run setup

Common development commands:

npm run core:build
npm run core:test
npm run cca:test
npm run docs:build

To scaffold a real app from the current branch packages:

npm run sandbox:create -- --name release-test

The sandbox app is created under .sandbox/<name> and uses a local packed catalyst-core from the current branch.