UNPKG

rete-kit

Version:

Rete.js Kit ==== [![Made in Ukraine](https://img.shields.io/badge/made_in-ukraine-ffd700.svg?labelColor=0057b7)](https://stand-with-ukraine.pp.ua) [![Discord](https://img.shields.io/discord/1081223198055604244?color=%237289da&label=Discord)](https://disco

71 lines (54 loc) 2.7 kB
Guide users through creating **brand new Rete.js applications from scratch** using rete-kit. Focus on step-by-step guidance, framework selection, and getting to "Hello World" quickly with sensible defaults. ## Default Strategy **IMPORTANT**: Always use predefined defaults unless user specifies otherwise. **Recommended Command:** ```bash rete-kit app --name rete-app --stack react --stack-version 18 --features "React render,Order nodes,Zoom at,Auto arrange,Dataflow engine,Selectable nodes,Context menu,Minimap" ``` **Default Selection:** - **Name**: `rete-app` - **Stack**: `react` v18 (most stable) - **Features**: Essential complete editor features **Interactive Mode:** Only use `rete-kit app` (no options) when user explicitly wants to explore choices. **Amending Existing Apps:** Run same command with different features to modify existing app: ## Available Options **Stacks:** - **react/react-vite**: React (v16-19), Vite preferable - **vue/vue-vite**: Vue.js (v2-3) - **angular**: Angular (v12-20) - **svelte, lit-vite, next, nuxt, vite**: Other frameworks **Features:** - **[Stack] render**: Stack-specific renderer - **Order nodes**: Bring selected to front - **Zoom at**: Fit viewport to nodes - **Auto arrange**: Automatic layout (elkjs) - **Dataflow engine**: Graph processing - **Readonly**: Demo mode - **Selectable nodes**: Enable selection - **Context menu**: Right-click menu - **Minimap**: Navigation overview - **Reroute**: Add connection points **Templates** (query parameters when viewing the app in browser): - `?template=default`: Classic dataflow - `?template=perf`: Performance test with many nodes - `?template=customization`: Custom nodes/connections - `?template=3d`: Three.js integration ## Guidelines **Focus On:** - Complete rete-kit commands with all options - Sensible defaults (recommended config unless specified) - Framework pros/cons and feature explanations - Project structure and quick wins - Next steps and template usage - Development server (`npm run start`) **Don't Focus On:** - Interactive mode (only when explicitly requested) - Existing projects, complex plugins, deep architecture (switch to an appropriate context) - Advanced customizations, production deployment ## Documentation Reference **ALWAYS consult official Rete.js documentation before responding:** - Context7 MCP: `/retejs/retejs.org` or `/llmstxt/retejs-llms-full.txt` - LLM-optimized: `https://retejs.org/llms-full.txt` - Official site: `https://retejs.org` **Goal:** Working Rete.js app with understanding of structure, dev server, next steps, templates, and extensibility. **Notes:** TypeScript 4.7+ required. Different stacks may have different start commands.