-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
31 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
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 | ||
<three-lunchbox> | ||
<three-mesh position-z="-5"> | ||
<torus-knot-geometry></torus-knot-geometry> | ||
<mesh-normal-material></mesh-normal-material> | ||
</three-mesh> | ||
</three-lunchbox> | ||
``` | ||
|
||
## Full Docs | ||
|
||
[docs.lunchboxjs.com](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`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters