Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/indulgeback/threejs-cli
threejs-cli is a command-line tool designed to help developers quickly scaffold Three.js projects with support for multiple frameworks, including Vanilla Three.js, TresJS (Vue + Three.js), and React Three Fiber (React + Three.js).
https://github.com/indulgeback/threejs-cli
cli react-three-fiber scaffolded threejs tresjs
Last synced: 12 days ago
JSON representation
threejs-cli is a command-line tool designed to help developers quickly scaffold Three.js projects with support for multiple frameworks, including Vanilla Three.js, TresJS (Vue + Three.js), and React Three Fiber (React + Three.js).
- Host: GitHub
- URL: https://github.com/indulgeback/threejs-cli
- Owner: indulgeback
- Created: 2025-01-15T04:03:58.000Z (15 days ago)
- Default Branch: main
- Last Pushed: 2025-01-15T05:46:30.000Z (15 days ago)
- Last Synced: 2025-01-15T07:33:48.306Z (15 days ago)
- Topics: cli, react-three-fiber, scaffolded, threejs, tresjs
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Three.js CLI Scaffold Tool
[中文](./README_zh.md)
`threejs-cli` is a command-line tool designed to help developers quickly scaffold Three.js projects with support for multiple frameworks, including **Vanilla Three.js**, **TresJS** (Vue + Three.js), and **React Three Fiber** (React + Three.js). Whether you're a beginner or an experienced developer, this tool allows you to focus on creativity and development without spending time on tedious project setup.
## Features
- **Supports multiple frameworks**:
- **Vanilla Three.js**
- **TresJS** (Vue + Three.js)
- **React Three Fiber** (React + Three.js)
- **One-command project generation**.
- **Automatically installs dependencies**.
- **Modern development experience based on Vite**.
- **Cross-platform support** (Windows, macOS, Linux).
## Installation
Install `threejs-cli` globally:
```bash
npm install -g threejs-cli
```
## Usage
Run the CLI tool:
```bash
create-threejs
```
Select a project name:
```bash
Select a project name: my-project
```
Select a framework:
```bash
? Select a framework: (Use arrow keys)
❯ Vanilla (原生 Three.js)
TresJS (Vue + Three.js)
React Three Fiber (React + Three.js)
```
Navigate to the project directory and start the development server:
```bash
cd my-project
npm install
npm run dev
```
## Example
### Create a TresJS-based project
```bash
create-threejs
```
### Select a project name
```bash
Select a project name: my-tresjs-project
```
### Select a framework
```bash
? Select a framework: (Use arrow keys)
❯ TresJS (Vue + Three.js)
Vanilla (原生 Three.js)
React Three Fiber (React + Three.js)
```
### Navigate to the project directory and start the development server
```bash
cd my-tresjs-project
npm install
npm run dev
```
## Contributing
We welcome contributions! Please submit issues or pull requests to improve threejs-cli.
## License
threejs-cli is open-source under the MIT License.