https://github.com/breakfast-studio/lunchboxjs

Declarative ThreeJS via web components
https://github.com/breakfast-studio/lunchboxjs

3d custom-elements three-js threejs web-components

Last synced: 6 days ago
JSON representation

Declarative ThreeJS via web components

• Host: GitHub
• URL: https://github.com/breakfast-studio/lunchboxjs
• Owner: breakfast-studio
• License: mit
• Created: 2021-11-18T17:36:34.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-08T21:05:07.000Z (3 months ago)
• Last Synced: 2025-01-29T02:45:52.492Z (13 days ago)
• Topics: 3d, custom-elements, three-js, threejs, web-components
• Language: TypeScript
• Homepage:
• Size: 20.4 MB
• Stars: 242
• Watchers: 3
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ccamel - breakfast-studio/lunchboxjs - Declarative ThreeJS via web components (TypeScript)

README

        
Lunchbox 2 lets you write [ThreeJS](https://threejs.org/) scenes using [web components](https://developer.mozilla.org/en-US/docs/Web/API/Web_components). You can use it in any (or no) framework.

```html

  

    

    

  

```

## Docs

[Install](https://docs.lunchboxjs.com/install.html)

[Full docs](https://docs.lunchboxjs.com/)

## About

Lunchbox started as a Vue + ThreeJS custom renderer, but from version 2 on will be focused on web components built into browsers.

## Local Dev

`npm install`, then `npm run dev` to run dev server. From there, edit source code in the LunchboxJS package's `/src/...` and examples in `/index.html/...` to build and test features.

`npm run test` to run headless tests, `npm run cy:open` to open Cypress test suites.

`npm run docs:dev` to run docs locally.

## Publishing

`npm run test` to make sure all tests pass, then `npm run publish`.