https://github.com/meganetaaan/moddable-boilerplate
Yet another moddableSDK project boilerplate with typescript, eslint and prettier.
https://github.com/meganetaaan/moddable-boilerplate
boilerplate docker moddable typescript
Last synced: 9 months ago
JSON representation
Yet another moddableSDK project boilerplate with typescript, eslint and prettier.
- Host: GitHub
- URL: https://github.com/meganetaaan/moddable-boilerplate
- Owner: meganetaaan
- License: cc0-1.0
- Created: 2019-02-14T03:24:50.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-04-10T01:56:04.000Z (about 4 years ago)
- Last Synced: 2025-04-03T04:41:36.560Z (about 1 year ago)
- Topics: boilerplate, docker, moddable, typescript
- Language: TypeScript
- Homepage:
- Size: 114 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Moddable Project Boilerplate
This is a boilerplate for projects with [Moddable SDK](https://www.moddable.com/).
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
```cmd
$ npm install
```
* Allow opening GUI from inside a container
```cmd
# in host environment
$ xhost +local:
```
### without devcontainer
* Install the required
* Moddable SDK
* Node.js ~10.0
* Install npm dependencies
```cmd
$ npm install
```
## Usage
### Debug
```cmd
$ npm run debug:[m5stack|lin]
```
### Deploy
```cmd
$ 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](./LICENSE) for the detail.