https://github.com/epreston/template-web-playcanvas
Repo template leveraging the PlayCanvas ecosystem.
https://github.com/epreston/template-web-playcanvas
playcanvas template vite web
Last synced: 5 months ago
JSON representation
Repo template leveraging the PlayCanvas ecosystem.
- Host: GitHub
- URL: https://github.com/epreston/template-web-playcanvas
- Owner: epreston
- License: mit
- Created: 2023-08-25T07:09:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-01-14T21:47:48.000Z (5 months ago)
- Last Synced: 2026-01-15T00:41:19.032Z (5 months ago)
- Topics: playcanvas, template, vite, web
- Language: JavaScript
- Homepage:
- Size: 1.33 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# PlayCanvas Template Web Project
Repo template leveraging the PlayCanvas ecosystem.
[![CI][ci-badge]][ci-url]
https://github.com/epreston/template-web-playcanvas/assets/347224/1e36e163-660b-4eee-bd3e-2bd5d5efc59b
## Quick Start
Install [Node.js](https://nodejs.org/en/download/), start a new repository using this [template](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template), create a local [clone](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) of your new repository, and run the following console commands within your local copy:
```bash
# install dependencies
npm install
# start a local server in development mode
npm run dev
```
## Scripts
| Action | Command | Description |
| ------ | ---------------- | ------------------------------------- |
| dev | `npm run dev` | Start live coding development server |
| build | `npm run build` | Create a production build into "dist" |
| lint | `npm run lint` | Run static code analysis |
| start | `npm run start` | Start server and open in browser |
| format | `npm run format` | Format code in the PlayCanvas style |
## Libraries
| Library | Reference |
| ---------- | ---------------------- |
| PlayCanvas | https://playcanvas.com |
## Ecosystem
| Tool | Reference |
| ------------- | ------------------------------------------------------ |
| Engine | https://github.com/playcanvas/engine |
| Editor | https://github.com/playcanvas/editor |
| Model Viewer | https://github.com/playcanvas/model-viewer |
| UI Library | https://github.com/playcanvas/pcui |
| ESLint Config | https://github.com/playcanvas/playcanvas-eslint-config |
## Tools
| Tool | Reference |
| ------------ | ------------------------ |
| Node.js | https://nodejs.org |
| Vite | https://vitejs.dev |
| ESLint | https://eslint.org |
| Prettier | https://prettier.io |
| EditorConfig | https://editorconfig.org |
## References
| Website | Reference |
| ------------------- | -------------------------------- |
| PlayCanvas API | https://developer.playcanvas.com |
| Can I Use | https://caniuse.com |
| Browserslist | https://browsersl.ist |
| Web Platform Status | https://webstatus.dev |
| WebGL2 | https://www.khronos.org/webgl/ |
| glTF | https://www.khronos.org/gltf/ |
| Fundamentals | https://webgl2fundamentals.org |
## License
This template is released under the MIT [License](LICENSE).
[ci-badge]: https://github.com/epreston/template-web-playcanvas/actions/workflows/ci.yml/badge.svg
[ci-url]: https://github.com/epreston/template-web-playcanvas/actions