Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update materia-widget-development-kit.md #24

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update materia-widget-development-kit.md #24

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 6 additions & 29 deletions _developers/materia-widget-development-kit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ The MWDK automatically watches changes to your widget source files and re-builds

## Some MWDK Features include:

* Locally hosts widget players and creators for rapid development
* Supports rapid development of player, creator, and score screen* interfaces
* Uses the same Javascript as the production Materia Server
* Utility for easily building .wigt packages and installation to a local Materia instance
* Materia API mocking
* Live reloading
* Reusable Webpack rules common to many widget build processes
* Icon generator and screenshot annotation tools

*experimental feature

{% include figure.html
url="mwdk/mwdk-home.png"
alt="MWDK home screen showing the Crossword widget."
Expand Down Expand Up @@ -60,19 +63,7 @@ To aid in widget packaging and testing, MWDK includes features to build and down

The MWDK is an [npm package](https://www.npmjs.com/package/materia-widget-development-kit) that is included as a dev dependency in your widget's package.json.

> While you can use either yarn or npm to install and run the dev kit, we recommend yarn.

### Install with yarn:

```shell
$ yarn add materia-widget-development-kit --dev
```

### Install with npm:

```shell
$ npm install materia-widget-development-kit --save-dev
```
For installation, visit the [MWDK wiki page](https://github.com/ucfopen/Materia-Widget-Dev-Kit/wiki).

### Using the MWDK's common Webpack Rules

Expand All @@ -90,18 +81,4 @@ This function returns the default items that need to be copied verbatim from the

#### `getDefaultEntries()`

This function adds the player and creator js and css files to the entries. However, it is reccommended that you create your own entries variable instead of using this function because the function only support CoffeScript for its JavaScript files.

### Running the MWDK

With yarn:

```shell
$ yarn start
```

With npm:

```shell
$ npm run start
```
This function adds the player and creator js and css files to the entries. However, it is recommended that you create your own entries variable instead of using this function because the function only support CoffeScript for its JavaScript files.