Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

# Dependencies
node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.DS_Store
*/.DS_Store
**/.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?

# Vite
.vite
69 changes: 69 additions & 0 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
# liquidGL - Development Setup

## 🚀 Quick Start

### Install Dependencies
```bash
npm install
```

### Start Development Server
```bash
npm run dev
```

This will start the Vite dev server at **http://localhost:3000** and automatically open your browser.

### Build for Production
```bash
npm run build
```

This creates an optimized production build in the `dist` folder.

### Preview Production Build
```bash
npm run preview
```

## 📁 Project Structure

```
liquidGL/
├── index.html # Main HTML file
├── css/
│ └── styles.css # All styles
├── scripts/
│ ├── navigation.js # Navigation module
│ ├── preloader.js # Preloader module
│ ├── liquidgl-init.js # LiquidGL initialization
│ ├── video-player.js # Video player module
│ ├── html2canvas.min.js # HTML2Canvas library
│ └── liquidGL.js # LiquidGL library
├── assets/ # Images, videos, fonts
├── demos/ # Demo pages
├── package.json # Project dependencies
└── vite.config.js # Vite configuration
```

## ✨ Features

- ⚡ **Lightning Fast** - Vite dev server with instant HMR
- 🔥 **Hot Module Replacement** - Changes appear instantly
- 🚫 **No CORS Issues** - Proper dev server handling
- 📦 **Optimized Builds** - Production-ready output
- 🎯 **Modern Tooling** - Industry-standard workflow

## 🛠️ Development

The Vite dev server will:
- Auto-reload on file changes
- Handle CORS properly (no more WebGL errors!)
- Serve files with proper MIME types
- Enable source maps for debugging

## 📝 Notes

- The dev server runs on port 3000 by default
- Browser will open automatically when you run `npm run dev`
- All paths are configured to work with Vite's asset handling
Loading