Skip to content

This package will create a starter boilerplate for three.js with 0 configurations (Plug n' play). You can also select from threejs.org/examples. Pretty much like `create-react-app`

License

GmBodhi/create-three-app

Repository files navigation

create-three-app

NPM version NPM downloads

NPM Banner

Star the repo?

If you think this repo is worth a star✨ just don't hesitate :)

Note: We don't recommend installing this package globally.

Usage

Run with --help flag to know more!

npx create-three-app {dir_name}

or

yarn create three-app {dir_name}

Using an example from threejs.org/examples

You need to run the command with -i or -e flag. Example: \

# -i or --interactive
npx create-three-app -i

# You can specify the name of the example.
yarn create three-app -e webgl_shader

We don't recommend this for beginners, as there can be some bugs that you may have to resolve manually (converting examples to webpack (node) compatible packages is an automated task) to work everything correctly or even starting the server. You may check assets.json for information about unresolved URLs, which may or may not stop the web server from initiating, or the unexpected behaviour of the website.

Example

FormatFactory.Screen.Record20211028_154139.mp4

Contributing

Thank you for your interest in contributing to this project! We're interested in adding more examples and maintaining those that are already in use. We're also loking forward for a better webpack configuration system. All contributions must abide by the Contributor Covenant Code of Conduct.

Want support?

Open an issue in the github repo or ask in the Secret Discord Server

About

This package will create a starter boilerplate for three.js with 0 configurations (Plug n' play). You can also select from threejs.org/examples. Pretty much like `create-react-app`

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •