Skip to content

Latest commit

 

History

History
65 lines (47 loc) · 1.11 KB

README.md

File metadata and controls

65 lines (47 loc) · 1.11 KB
Raw

Moddable Project Boilerplate

This is a boilerplate for projects with Moddable SDK. This repository enhances your developer experience with a number of Node.js developer tools that are the de facto standard today.

  • TypeScript
  • ESLint
  • Prettier
  • npm
  • Docker devcontainer for VSCode

Installation

With Devcontainer

  • Install the required.
    • VSCode
    • Docker and docker-compose
  • Open this repository with VSCode
  • Click a green arrow on bottom-left of the window
  • Select "Reopen in container" on popup
  • Install npm dependencies
$ npm install
  • Allow opening GUI from inside a container
# in host environment
$ xhost +local:

without devcontainer

  • Install the required
    • Moddable SDK
    • Node.js ~10.0
  • Install npm dependencies
$ npm install

Usage

Debug

$ npm run debug:[m5stack|lin]

Deploy

$ npm run deploy:[m5stack|lin]

LICENSE

This boilerplate is distributed under Creative Commons Zero license. You can use, modify and redistribute it without notice. See LICENSE for the detail.