Catalyst

A modern CLI tool for scaffolding React applications, developed by Transpiled.

Overview

Catalyst accelerates React application development by providing a robust, opinionated project structure with built-in support for modern tooling and best practices.

Features

• Instant Project Setup: Generate a complete React project structure in seconds
• Modern Stack:
  • React for UI development
  • Emotion for CSS-in-JS styling
  • Parcel for zero-config bundling
  • ESLint and Prettier for code quality
  • Yarn for dependency management
  • Jest and React Testing Library
  • SEO with React Helmet
• Developer Experience: Intuitive CLI with visual feedback and guided setup
• Customizable Templates: Support for various project types and configurations

Installation

Prerequisites

Catalyst is built with Rust and distributed via crates.io. You'll need to have Rust and Cargo (Rust's package manager) installed on your system.

If you don't have Rust installed:

1. Install Rust

   • On macOS and Linux:

     curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
     

   • On Windows:
     • Download and run rustup-init.exe from rustup.rs

2. After installation, restart your terminal and verify the installation:

   rustc --version
   cargo --version
   

Installing Catalyst

Once Rust and Cargo are installed, you can install Catalyst using:

cargo install transpiled-catalyst

To verify the installation:

catalyst --version

Quick Start

After installation, create a new React project:

catalyst 

catalyst will create the new project in your current directory. Follow the on screen instruction.

Scripts

Once the project is created and you are in the new project directory, you can run the following commands.

• yarn dev: Start development server
• yarn build: Create production build
• yarn lint: Run ESLint
• yarn format: Format code with Prettier
• yarn test: Run test suite

Deployment

Deploying to Netlify

Catalyst projects come pre-configured for Netlify deployment. Additional options in future versions.

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

MIT © Transpiled

Support

For issues and feature requests, please file an issue on our GitHub repository.

Troubleshooting

Common Installation Issues

1. If you see "command not found: cargo":

   • Make sure you've installed Rust and Cargo as described above
   • Restart your terminal to load the new PATH changes

2. If you encounter permissions errors:

   • On Unix-based systems, try:

     sudo cargo install transpiled-catalyst
     

   • On Windows, run your terminal as administrator

Made with ♥ by Transpiled