Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/petercsipkay/basic-three.js-starter-kit

A minimal Three.js boilerplate to help you get started with 3D web development. This template includes a basic scene setup with a rotating cube, proper lighting, camera controls, and responsive canvas.
https://github.com/petercsipkay/basic-three.js-starter-kit

3d 3d-graphics 3dwebsite boilerplate boilerplate-template three-js threejs threejs-boilerplate threejs-template webgl webgl2

Last synced: about 1 month ago
JSON representation

A minimal Three.js boilerplate to help you get started with 3D web development. This template includes a basic scene setup with a rotating cube, proper lighting, camera controls, and responsive canvas.

Awesome Lists containing this project

README

        

# Three.js Resources Boilerplate

A minimal Three.js boilerplate to help you get started with 3D web development. This template includes a basic scene setup with a rotating cube, proper lighting, camera controls, and responsive canvas.

## Features

- Basic Three.js scene setup
- Responsive canvas
- OrbitControls for camera manipulation
- Proper lighting setup
- Shadow support
- Animation system with consistent timing
- Fullscreen support
- Clean project structure

## Setup

Download [Node.js](https://nodejs.org/en/download/). Run these commands:

```bash
# Install dependencies (only the first time)
npm install

# Run the local server at localhost:8080
npm run dev

# Build for production in the dist/ directory
npm run build
```

## Project Structure

```
├── src/
│ ├── css/
│ │ └── index.css
│ └── js/
│ └── main.js
├── index.html
├── package.json
└── vite.config.js
```

## Dependencies

- Three.js
- Vite (for building and development)

## Resources

For more Three.js resources, tutorials, and tools, visit:

- [Three.js Resources](https://threejsresources.com/) - A curated collection of Three.js resources
- [Three.js Documentation](https://threejs.org/docs/)

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Contributing

Feel free to submit issues and enhancement requests!

## Acknowledgments

This boilerplate is designed to provide a clean starting point for Three.js projects. For more advanced features and resources, check out [threejsresources.com](https://threejsresources.com/).

## Author

[Peter Csipkay](https://petercsipkay.com/)