Add README with project documentation
🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
68
README.md
Normal file
68
README.md
Normal file
@@ -0,0 +1,68 @@
|
||||
# DruckWerk
|
||||
|
||||
A professional 3D printer enclosure documentation site built with SvelteKit.
|
||||
|
||||
## About
|
||||
|
||||
DruckWerk documents the construction of a professional 3D printer enclosure built from an IKEA table. The enclosure features:
|
||||
|
||||
- Fixed 230V power input via IEC C14
|
||||
- Internal AC distribution via WAGO terminals
|
||||
- Dual-output PSU (12V + 5V)
|
||||
- ESP32 control with PWM for LEDs and fans
|
||||
- Home Assistant integration
|
||||
- Cleanly separated AC and DC zones
|
||||
- BME280 temperature and humidity sensor
|
||||
- Carbon filter exhaust system
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- [SvelteKit](https://kit.svelte.dev/) - Web framework
|
||||
- [Svelte 5](https://svelte.dev/) - UI framework
|
||||
- [Tailwind CSS 4](https://tailwindcss.com/) - Styling
|
||||
- [TypeScript](https://www.typescriptlang.org/) - Type safety
|
||||
- [Lucide](https://lucide.dev/) - Icons
|
||||
|
||||
## Features
|
||||
|
||||
- Bilingual support (English / German)
|
||||
- Dark / Light theme toggle
|
||||
- Responsive design
|
||||
- Component-based documentation structure
|
||||
- Materials list with specifications
|
||||
- Step-by-step build instructions
|
||||
- Wiring diagrams and pinouts
|
||||
- Final safety checklist
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Start development server
|
||||
npm run dev
|
||||
|
||||
# Build for production
|
||||
npm run build
|
||||
|
||||
# Preview production build
|
||||
npm run preview
|
||||
```
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
src/
|
||||
├── lib/
|
||||
│ ├── components/ # Reusable UI components
|
||||
│ ├── data/ # Materials and specifications
|
||||
│ ├── i18n/ # Translations (en, de)
|
||||
│ └── stores/ # Svelte stores (language, theme)
|
||||
├── routes/ # SvelteKit pages
|
||||
└── app.css # Global styles
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the GPL-3.0-or-later license. See [LICENSE](LICENSE) for details.
|
||||
Reference in New Issue
Block a user