Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 2.88 KB

README.md

File metadata and controls

73 lines (53 loc) · 2.88 KB

PlayCanvas Template Web Project

Repo template leveraging the PlayCanvas ecosystem.

CI

pc-template-md.mp4

Quick Start

Install Node.js, start a new repository using this template, create a local clone of your new repository, and run the following console commands within your local copy:

# 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
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.