Add Claude.md

Author: justin808

CLAUDE.md

@@ -0,0 +1,75 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+### Essential Commands
+- **Install dependencies**: `bundle && yarn`
+- **Run tests**: 
+  - Ruby tests: `rake run_rspec`
+  - JavaScript tests: `yarn run test` or `rake js_tests`
+  - All tests: `rake` (default task runs lint and all tests except examples)
+- **Linting**:
+  - All linters: `rake lint` (runs ESLint and RuboCop)
+  - ESLint only: `yarn run lint` or `rake lint:eslint`
+  - RuboCop only: `rake lint:rubocop`
+- **Build**: `yarn run build` (compiles TypeScript to JavaScript in node_package/lib)
+- **Type checking**: `yarn run type-check`
+
+### Development Setup Commands
+- **Initial setup**: `bundle && yarn && rake shakapacker_examples:gen_all && rake node_package && rake`
+- **Prepare examples**: `rake shakapacker_examples:gen_all`
+- **Generate node package**: `rake node_package`
+- **Run single test example**: `rake run_rspec:example_basic`
+
+### Test Environment Commands
+- **Dummy app tests**: `rake run_rspec:dummy`
+- **Gem-only tests**: `rake run_rspec:gem`
+- **All tests except examples**: `rake all_but_examples`
+
+## Project Architecture
+
+### Dual Package Structure
+This project maintains both a Ruby gem and an NPM package:
+- **Ruby gem**: Located in `lib/`, provides Rails integration and server-side rendering
+- **NPM package**: Located in `node_package/src/`, provides client-side React integration
+
+### Core Components
+
+#### Ruby Side (`lib/react_on_rails/`)
+- **`helper.rb`**: Rails view helpers for rendering React components
+- **`server_rendering_pool.rb`**: Manages Node.js processes for server-side rendering
+- **`configuration.rb`**: Global configuration management
+- **`engine.rb`**: Rails engine integration
+- **Generators**: Located in `lib/generators/react_on_rails/`
+
+#### JavaScript/TypeScript Side (`node_package/src/`)
+- **`ReactOnRails.ts`**: Main entry point for client-side functionality
+- **`serverRenderReactComponent.ts`**: Server-side rendering logic
+- **`ComponentRegistry.ts`**: Manages React component registration
+- **`StoreRegistry.ts`**: Manages Redux store registration
+
+### Build System
+- **Ruby**: Standard gemspec-based build
+- **JavaScript**: TypeScript compilation to `node_package/lib/`
+- **Testing**: Jest for JS, RSpec for Ruby
+- **Linting**: ESLint for JS/TS, RuboCop for Ruby
+
+### Examples and Testing
+- **Dummy app**: `spec/dummy/` - Rails app for testing integration
+- **Examples**: Generated via rake tasks for different webpack configurations
+- **Rake tasks**: Defined in `rakelib/` for various development operations
+
+## Important Notes
+- Use `yalc` for local development when testing with external apps
+- The project supports both Webpacker and Shakapacker
+- Server-side rendering uses isolated Node.js processes
+- React Server Components support available in Pro version
+- Generated examples are in `gen-examples/` (ignored by git)
+
+## IDE Configuration
+Exclude these directories to prevent IDE slowdowns:
+- `/coverage`, `/tmp`, `/gen-examples`, `/node_package/lib`
+- `/node_modules`, `/spec/dummy/node_modules`, `/spec/dummy/tmp`
+- `/spec/dummy/app/assets/webpack`, `/spec/dummy/log`