OpenSCAD Web Editor 🎨

A modern, feature-rich (well, not yet) editor for OpenSCAD, built with Tauri, React, and TypeScript. Create, edit, and visualize 3D models, powered by WebAssembly.

✨ Features

• 🚀 Real-time OpenSCAD compilation and preview

• 🌐 WebAssembly-powered OpenSCAD engine

• 💻 Cross-platform support (Windows, macOS, Linux)

🗺️ Roadmap

• Syntax highlighting
• Auto-completion and code snippets
• Integrated documentation viewer
• File system integration
• Export to various 3D formats
• Parameter customization UI
• Integrated debugging tools
• Flow editor

🛠️ Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v21 or newer)
• pnpm (v10 or newer)
• Rust
• Git

📦 Installation

1. Clone the repository:

git clone https://github.com/RemcoGoy/scadflow.git
cd scadflow

2. Build the WebAssembly components:

make wasm
make public

3. Install dependencies:

pnpm install

4. Start the development server:

pnpm run tauri dev

🏗️ Building for Production

pnpm run tauri build

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📚 References & Inspiration

This project stands on the shoulders of giants:

• OpenSCAD - The original OpenSCAD project
• OpenSCAD WASM - WebAssembly build of OpenSCAD
• OpenSCAD Playground - Web-based OpenSCAD editor
• OpenSCAD Documentation - Official OpenSCAD documentation

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• The OpenSCAD team for their amazing work
• All contributors and supporters of this project

---

Made with ❤️ by Remco Goyvaerts