@crapthings/run3d 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 crapthings
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# run3d
+
+A simple 3D sandbox so you don't have to set up the same project every time.
+JavaScript, Vite, React Three Fiber, Drei, and Tailwind CSS — with a grid and a box to start with.
+
+## Usage
+
+Requires Node.js `^20.19.0 || >=22.12.0` and pnpm.
+
+```bash
+npx @crapthings/run3d my-project
+cd my-project
+pnpm dev
+```
+
+Edit `src/Scene.jsx` and start building. Use `--skip-install` to skip dependency installation.

package/bin/run3d.js

@@ -0,0 +1,141 @@
+#!/usr/bin/env node
+
+import { access, cp, mkdir, readFile, rename, readdir, writeFile } from 'node:fs/promises'
+import { spawn } from 'node:child_process'
+import { fileURLToPath } from 'node:url'
+import { dirname, join, resolve } from 'node:path'
+
+const packageDirectory = dirname(fileURLToPath(import.meta.url))
+const templateDirectory = resolve(packageDirectory, '../template')
+const excludedTemplateEntries = new Set(['dist', 'node_modules'])
+const packageJson = JSON.parse(
+  await readFile(resolve(packageDirectory, '../package.json'), 'utf8')
+)
+
+function printUsage () {
+  console.log(`\nUsage: npx ${packageJson.name} <project-name> [--skip-install]\n\nOptions:\n  --skip-install  Create files without running pnpm install\n  -h, --help      Show this help message\n  -v, --version   Show the CLI version\n`)
+}
+
+function fail (message) {
+  console.error(`\nerror: ${message}\n`)
+  process.exitCode = 1
+}
+
+function run (command, args, cwd) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(command, args, { cwd, stdio: 'inherit', shell: process.platform === 'win32' })
+
+    child.on('error', reject)
+    child.on('close', (code) => {
+      if (code === 0) {
+        resolve()
+        return
+      }
+      reject(new Error(`${command} ${args.join(' ')} exited with code ${code}`))
+    })
+  })
+}
+
+async function isEmptyDirectory (directory) {
+  try {
+    return (await readdir(directory)).length === 0
+  } catch (error) {
+    if (error && error.code === 'ENOENT') return true
+    throw error
+  }
+}
+
+async function exists (path) {
+  try {
+    await access(path)
+    return true
+  } catch {
+    return false
+  }
+}
+
+async function main () {
+  const argumentsList = process.argv.slice(2)
+
+  if (argumentsList.includes('-h') || argumentsList.includes('--help')) {
+    printUsage()
+    return
+  }
+
+  if (argumentsList.includes('-v') || argumentsList.includes('--version')) {
+    console.log(packageJson.version)
+    return
+  }
+
+  const skipInstall = argumentsList.includes('--skip-install')
+  const positionalArguments = argumentsList.filter((argument) => !argument.startsWith('-'))
+
+  if (positionalArguments.length !== 1) {
+    fail('provide exactly one project name.')
+    printUsage()
+    return
+  }
+
+  const projectName = positionalArguments[0]
+  if (!/^[a-z0-9][a-z0-9._-]*$/i.test(projectName)) {
+    fail('project name may contain only letters, numbers, dots, underscores, and hyphens.')
+    return
+  }
+
+  const targetDirectory = resolve(process.cwd(), projectName)
+  if ((await exists(targetDirectory)) && !(await isEmptyDirectory(targetDirectory))) {
+    fail(`target directory already exists and is not empty: ${targetDirectory}`)
+    return
+  }
+
+  await mkdir(targetDirectory, { recursive: true })
+  const templateEntries = (await readdir(templateDirectory)).filter(
+    (entry) => !excludedTemplateEntries.has(entry)
+  )
+  await Promise.all(
+    templateEntries.map((entry) =>
+      cp(join(templateDirectory, entry), join(targetDirectory, entry), {
+        recursive: true,
+        force: false,
+        errorOnExist: true
+      })
+    )
+  )
+
+  const renamedTemplateFiles = [
+    ['gitignore', '.gitignore'],
+    ['npmrc', '.npmrc']
+  ]
+  for (const [sourceName, targetName] of renamedTemplateFiles) {
+    const source = join(targetDirectory, sourceName)
+    if (await exists(source)) {
+      await rename(source, join(targetDirectory, targetName))
+    }
+  }
+
+  const generatedPackagePath = join(targetDirectory, 'package.json')
+  const generatedPackage = JSON.parse(await readFile(generatedPackagePath, 'utf8'))
+  generatedPackage.name = projectName.toLowerCase()
+  await writeFile(generatedPackagePath, `${JSON.stringify(generatedPackage, null, 2)}\n`)
+
+  console.log(`\nCreated ${projectName} in ${targetDirectory}.`)
+
+  if (skipInstall) {
+    console.log(`\nNext steps:\n  cd ${projectName}\n  pnpm install\n  pnpm dev\n`)
+    return
+  }
+
+  try {
+    await run('pnpm', ['install'], targetDirectory)
+    console.log(`\nReady. Start the app with:\n  cd ${projectName}\n  pnpm dev\n`)
+  } catch (error) {
+    if (error && error.code === 'ENOENT') {
+      console.log(`\npnpm was not found. Install it, then run:\n  cd ${projectName}\n  pnpm install\n  pnpm dev\n`)
+      return
+    }
+
+    fail(`dependencies could not be installed. The project was created; run pnpm install in it to retry.\n${error.message}`)
+  }
+}
+
+main().catch((error) => fail(error.message))

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@crapthings/run3d",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.1.0",
+  "description": "Create a minimal Vite, React Three Fiber, and Drei Grid starter project",
+  "type": "module",
+  "bin": {
+    "run3d": "bin/run3d.js"
+  },
+  "files": [
+    "bin",
+    "template/gitignore",
+    "template/index.html",
+    "template/jsconfig.json",
+    "template/npmrc",
+    "template/package.json",
+    "template/pnpm-lock.yaml",
+    "template/src",
+    "template/vite.config.js"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "scripts": {
+    "lint": "standard \"bin/**/*.js\" \"test/**/*.js\" \"template/src/**/*.{js,jsx}\" template/vite.config.js",
+    "lint:fix": "pnpm lint --fix",
+    "test": "node --test",
+    "pack:check": "npm pack --dry-run"
+  },
+  "keywords": [
+    "vite",
+    "react",
+    "three",
+    "react-three-fiber",
+    "drei",
+    "starter",
+    "cli"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/crapthings/run3d.git"
+  },
+  "homepage": "https://github.com/crapthings/run3d#readme",
+  "bugs": {
+    "url": "https://github.com/crapthings/run3d/issues"
+  },
+  "devDependencies": {
+    "standard": "^17.1.2"
+  }
+}

package/template/gitignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+.DS_Store
+*.local

package/template/index.html

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <meta name="theme-color" content="#e8edf3" />
+    <title>Run3D</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.jsx"></script>
+  </body>
+</html>

package/template/jsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src"]
+}

package/template/npmrc

@@ -0,0 +1,2 @@
+auto-install-peers=true
+strict-peer-dependencies=true

package/template/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "__PROJECT_NAME__",
+  "private": true,
+  "version": "0.0.0",
+  "type": "module",
+  "packageManager": "pnpm@11.20.0",
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "@react-three/drei": "^10.7.8",
+    "@react-three/fiber": "^9.7.0",
+    "react": "19.3.0",
+    "react-dom": "19.3.0",
+    "three": "^0.186.0"
+  },
+  "devDependencies": {
+    "@tailwindcss/vite": "^4.3.3",
+    "@vitejs/plugin-react": "^6.1.1",
+    "tailwindcss": "^4.3.3",
+    "vite": "^8.3.0"
+  }
+}