|
| 1 | +# render-neural | Scaffolding System |
| 2 | + |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +## 🚀 Quick Launch |
| 9 | + |
| 10 | +The application includes a built-in scaffolding system that provides multiple ways to launch and develop the neural rendering platform. |
| 11 | + |
| 12 | +### Browser Interface |
| 13 | + |
| 14 | +Open `index.html` in your browser to access the scaffolding interface with: |
| 15 | + |
| 16 | +- **🚀 Development Server** - Launch Vite dev server |
| 17 | +- **🔨 Build Application** - Create production build |
| 18 | +- **⚛️ Launch React App** - Direct React mount bypass |
| 19 | + |
| 20 | +### Command Line Interface |
| 21 | + |
| 22 | +```bash |
| 23 | +# Using the launcher script |
| 24 | +npm run launch:dev # Start development server |
| 25 | +npm run launch:build # Build for production |
| 26 | +npm run launch:install # Install dependencies |
| 27 | + |
| 28 | +# Or directly |
| 29 | +node launch.js dev # Start development server |
| 30 | +node launch.js build # Build for production |
| 31 | +node launch.js help # Show all commands |
| 32 | +``` |
| 33 | + |
| 34 | +### Direct Commands |
| 35 | + |
| 36 | +```bash |
| 37 | +npm run dev # Start Vite development server |
| 38 | +npm run build # Build for production |
| 39 | +npm run preview # Preview production build |
| 40 | +npm install # Install dependencies |
| 41 | +``` |
| 42 | + |
| 43 | +## 🏗️ Application Architecture |
| 44 | + |
| 45 | +### Core Systems |
| 46 | + |
| 47 | +- **Asset Management** - File ingestion, search, GitHub sync |
| 48 | +- **Sensor Control** - Depth cameras, LiDAR, thermal, multispectral |
| 49 | +- **Operations Console** - Depth processing, normals, point clouds, Gaussian splats |
| 50 | +- **Stability AI Integration** - Image/video generation, neural rendering |
| 51 | +- **Autonomous Deployment** - Sector management, AI agents, calibration |
| 52 | + |
| 53 | +### Technical Stack |
| 54 | + |
| 55 | +**Frontend** |
| 56 | +- React 18 with TypeScript |
| 57 | +- Vite for development and building |
| 58 | +- Tailwind CSS for styling |
| 59 | + |
| 60 | +**UI Components** |
| 61 | +- Radix UI primitives |
| 62 | +- shadcn/ui components |
| 63 | +- Lucide icons |
| 64 | + |
| 65 | +**3D Rendering** |
| 66 | +- Three.js for 3D graphics |
| 67 | +- WebGL for hardware acceleration |
| 68 | +- Canvas API for 2D rendering |
| 69 | + |
| 70 | +**AI Integration** |
| 71 | +- Stability AI for content generation |
| 72 | +- Neural networks for processing |
| 73 | +- Computer vision algorithms |
| 74 | + |
| 75 | +## 🎯 Scaffolding Features |
| 76 | + |
| 77 | +### Interactive Launch Interface |
| 78 | + |
| 79 | +The scaffolding system provides an interactive web interface that allows you to: |
| 80 | + |
| 81 | +1. **View System Status** - See all components and their health |
| 82 | +2. **Launch Development Tools** - Start dev server, build, or deploy |
| 83 | +3. **Monitor Terminal Output** - Real-time feedback and logging |
| 84 | +4. **Access Documentation** - Built-in help and guides |
| 85 | + |
| 86 | +### Keyboard Shortcuts |
| 87 | + |
| 88 | +When in scaffolding mode, use these shortcuts: |
| 89 | + |
| 90 | +- `Ctrl/Cmd + D` - Launch development server |
| 91 | +- `Ctrl/Cmd + B` - Build application |
| 92 | +- `Ctrl/Cmd + R` - Launch React app directly |
| 93 | +- `Ctrl/Cmd + C` - Clear terminal output |
| 94 | + |
| 95 | +### Auto-Launch URLs |
| 96 | + |
| 97 | +You can bypass the scaffolding interface with URL parameters: |
| 98 | + |
| 99 | +``` |
| 100 | +http://localhost/index.html?launch=react # Direct React launch |
| 101 | +http://localhost/index.html?launch=dev # Auto-start dev mode |
| 102 | +``` |
| 103 | + |
| 104 | +## 📊 Development Status |
| 105 | + |
| 106 | +✅ **Components Fixed** - All TypeScript errors resolved |
| 107 | +✅ **Build Ready** - Vite + React + TypeScript configured |
| 108 | +✅ **Launch Ready** - Development server available |
| 109 | +✅ **Scaffolding Active** - Interactive launch interface |
| 110 | + |
| 111 | +## 🛠️ Development Workflow |
| 112 | + |
| 113 | +### First Time Setup |
| 114 | + |
| 115 | +1. **Clone and Install** |
| 116 | + ```bash |
| 117 | + git clone <repository> |
| 118 | + cd lolo-ren |
| 119 | + npm install |
| 120 | + ``` |
| 121 | + |
| 122 | +2. **Launch Scaffolding** |
| 123 | + ```bash |
| 124 | + # Open index.html in browser OR |
| 125 | + npm run dev |
| 126 | + ``` |
| 127 | + |
| 128 | +3. **Start Development** |
| 129 | + - Use scaffolding interface to launch dev server |
| 130 | + - Or run `npm run dev` directly |
| 131 | + - Navigate to `http://localhost:5173` |
| 132 | + |
| 133 | +### Build and Deploy |
| 134 | + |
| 135 | +```bash |
| 136 | +# Build for production |
| 137 | +npm run build |
| 138 | + |
| 139 | +# Preview production build |
| 140 | +npm run preview |
| 141 | + |
| 142 | +# Deploy dist/ folder to your hosting service |
| 143 | +``` |
| 144 | + |
| 145 | +## 🔧 Configuration |
| 146 | + |
| 147 | +### Vite Configuration |
| 148 | + |
| 149 | +Located in `vite.config.ts`: |
| 150 | +- TypeScript support |
| 151 | +- React plugin |
| 152 | +- Path aliases |
| 153 | +- Development server settings |
| 154 | + |
| 155 | +### Tailwind Configuration |
| 156 | + |
| 157 | +Located in `tailwind.config.js`: |
| 158 | +- Custom color schemes |
| 159 | +- Component variants |
| 160 | +- Responsive breakpoints |
| 161 | + |
| 162 | +### TypeScript Configuration |
| 163 | + |
| 164 | +Located in `tsconfig.json`: |
| 165 | +- Strict type checking |
| 166 | +- Modern ES features |
| 167 | +- Path mapping |
| 168 | + |
| 169 | +## 📱 Browser Compatibility |
| 170 | + |
| 171 | +- **Chrome/Edge** 90+ (recommended) |
| 172 | +- **Firefox** 88+ |
| 173 | +- **Safari** 14+ |
| 174 | +- **Mobile** Safari iOS 14+, Chrome Android 90+ |
| 175 | + |
| 176 | +## 🚨 Troubleshooting |
| 177 | + |
| 178 | +### Common Issues |
| 179 | + |
| 180 | +**Port 5173 already in use** |
| 181 | +```bash |
| 182 | +# Kill process on port 5173 |
| 183 | +npx kill-port 5173 |
| 184 | +npm run dev |
| 185 | +``` |
| 186 | + |
| 187 | +**TypeScript errors** |
| 188 | +```bash |
| 189 | +# Clear cache and reinstall |
| 190 | +rm -rf node_modules package-lock.json |
| 191 | +npm install |
| 192 | +``` |
| 193 | + |
| 194 | +**Scaffolding not showing** |
| 195 | +- Check console for JavaScript errors |
| 196 | +- Ensure index.html is served via HTTP (not file://) |
| 197 | +- Try hard refresh (Ctrl+F5) |
| 198 | + |
| 199 | +### Development Tools |
| 200 | + |
| 201 | +The scaffolding system includes debugging tools: |
| 202 | +- Real-time terminal output |
| 203 | +- Component health monitoring |
| 204 | +- Build status indicators |
| 205 | +- Error reporting |
| 206 | + |
| 207 | +## 📚 Additional Resources |
| 208 | + |
| 209 | +- [React Documentation](https://react.dev) |
| 210 | +- [Vite Documentation](https://vitejs.dev) |
| 211 | +- [TypeScript Documentation](https://www.typescriptlang.org) |
| 212 | +- [Tailwind CSS Documentation](https://tailwindcss.com) |
| 213 | + |
| 214 | +## 🤝 Contributing |
| 215 | + |
| 216 | +1. Fork the repository |
| 217 | +2. Create feature branch (`git checkout -b feature/amazing-feature`) |
| 218 | +3. Commit changes (`git commit -m 'Add amazing feature'`) |
| 219 | +4. Push to branch (`git push origin feature/amazing-feature`) |
| 220 | +5. Open Pull Request |
| 221 | + |
| 222 | +--- |
| 223 | + |
| 224 | +**render-neural** - Spatial Intelligence & Neural Field Processing Platform |
0 commit comments