create-r3f v1.8.0

create-r3f

A CLI tool to quickly create React Three Fiber (R3F) applications with a pre-configured setup.

Installation

npx create-r3f my-r3f-app

Using npx (recommended)

This will create a new R3F application in a directory called my-r3f-app with all necessary dependencies and configuration.

Features

• 🚀 Quick project setup for React Three Fiber
• ⚡️ Pre-configured development environment
• 📦 Includes essential dependencies
• 🎨 Basic template with example components
• 🛠 Ready-to-use project structure

Project Structure

my-app-name/ ├── public/ │ ├── favicon.ico │ ├── index.html │ ├── logo192.png │ ├── logo512.png │ ├── manifest.json │ └── robots.txt ├── src/ │ ├── App.js │ ├── App.css │ ├── index.js │ └── other configuration files └── package.json

Development

After creating your project:

cd my-r3f-app npm install npm start

This will start the development server on http://localhost:3000.

Contributing

Contributions are welcome! Feel free to submit issues and pull requests.

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

License

MIT © rajkumar_palanichamy

Made with ❤️ for the React Three Fiber community