-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
119 changed files
with
2,003 additions
and
802 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Port Extension to Framework | ||
about: Task for converting an existing extension to the new PRG framework form | ||
title: '' | ||
labels: extension framework | ||
assignees: '' | ||
|
||
--- | ||
|
||
# Details | ||
|
||
Old extension Location: `packages/scratch-vm/extensions/___` | ||
|
||
Branch name: `___` | ||
|
||
Folder name: `___` | ||
|
||
# Getting started | ||
|
||
## Checkout branch | ||
```bash | ||
git checkout dev | ||
git pull | ||
git checkout -b <branch-name> | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
name: Generate Extension Documentation | ||
|
||
on: [push] | ||
permissions: | ||
contents: write | ||
pages: write | ||
id-token: write | ||
jobs: | ||
generate: | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
node-version: [16.17.1] | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Use Node.js ${{ matrix.node-version }} | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: ${{ matrix.node-version }} | ||
- name: Initialize | ||
run: npm run init | ||
- name: Generate | ||
run: npm run document:extensions | ||
- uses: stefanzweifel/git-auto-commit-action@v4 | ||
with: | ||
commit_message: 're-generate extension documentation\n\nskip-checks:true' | ||
file_pattern: 'extensions/README.md' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Current development (ordered by priority) | ||
|
||
Items will be crossed off as they are completed and merged to dev. The merge & review process is documented [here](); | ||
|
||
@pmalacho-mit will manage merging dev to main periodically (at first as needed, but eventually on a regular schedule). | ||
|
||
- [Hat block update to support App Inventor interoperability](https://github.com/mitmedialab/prg-extension-boilerplate/issues/203) (easy) | ||
- [Document bundling/build process & project architecture]() (medium) | ||
- [First class Google Drive support]() (hard) | ||
- [Tutorial support all from extension's folder]() (medium) | ||
- [Loading curricullum 'recipes']() (medium) | ||
- Support all extension fields | ||
- [branchCount]() (easy) | ||
- [filter]() (easy) | ||
- [launchPeripheralConnectionFlow]() (easy) | ||
- [terminal]() (easy) | ||
- [Save/load data per extension]() | ||
- [Workers]() | ||
- First class support for other cloud providers (re-order based on feedback from teacher's schools) | ||
- Dropbox | ||
- OneDrive | ||
- Microsoft | ||
|
||
# Wishlist | ||
- Opencv / feature perception object classification and localization extension (maybe 2 seperate extensions) | ||
- Fly tello using scratch | ||
|
||
# Things that'd be awesome to do, but are likely more work than is currently worth it | ||
- Split every extension into it's own package | ||
- Custom block arguments |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -27,6 +27,8 @@ Assuming you have... | |
|
||
Run the following from the command line: | ||
|
||
(**NOTE:** If using gitpod, this all will be done for you on startup) | ||
|
||
```shell script | ||
git clone [email protected]:mitmedialab/prg-extension-boilerplate.git | ||
# Clone the repository onto your computer. This could take a while (~5m), grab a beverage! | ||
|
@@ -165,7 +167,7 @@ Also, try hovering over fields to view their documentation (typically a [summary | |
|
||
![Gif of video hovering over fields to peak documentation](/assets/hover.gif) | ||
|
||
Still stuck? Check out our [From 0 to Extension guide](#-from-0-to-extension) and/or contact more experienced Scratch developers, like [Parker](https://github.com/pmalacho-mit) or [Randi](https://github.com/randi-c-dubs) | ||
Still stuck? Check out our [From 0 to Extension guide](#-from-0-to-extension) and/or contact more experienced extension developers, like [Parker](https://github.com/pmalacho-mit) or [Randi](https://github.com/randi-c-dubs) | ||
|
||
### 🪜 From 0 to Extension | ||
|
||
|
@@ -174,7 +176,7 @@ Still stuck? Check out our [From 0 to Extension guide](#-from-0-to-extension) an | |
Currently, depending on what's new to you, here are some recommendations: | ||
- ***New to Javascript and Typescript?*** Follow this [javascript tutorial](https://www.w3schools.com/js/) and then check out the [Typescript handbook](https://www.typescriptlang.org/docs/handbook/intro.html) | ||
- ***Know javascript but new to Typescript?*** Check out the [Typescript handbook](https://www.typescriptlang.org/docs/handbook/intro.html) | ||
- ***Know javascript/typescript but never made an extension before?*** Nice! The documentation of the template `index.ts` should be enough to get you started (and if not, please give that feedback) | ||
- ***Know javascript/typescript but never made an extension before?*** Nice! The documentation of the template `index.ts` should be enough to get you started (and if not, please give us that feedback) | ||
- ***New to the extension framework (but had developed extensions in the past)?*** The [Porting an extension to Typescript guide](#-porting-an-extension-to-typescript) is likely for you! | ||
Probably will have: | ||
|
@@ -212,7 +214,7 @@ Like many web development projects, this project requires [node](https://nodejs. | |
|
||
Also, [due to a Webpack 4 issue](https://github.com/webpack/webpack/issues/14532), we require a node version <=16. | ||
|
||
Please locate the [latest v16 release](https://nodejs.org/en/blog/release) and install a suitable version for your operating system. | ||
Please locate the [latest v16 release](https://nodejs.org/en/blog/release) and install a suitable version for your operating system. If you already have node and need to downgrade to a version <= 16, please see these [instructions for downgrading node](https://www.educative.io/answers/how-to-downgrade-node-version). | ||
|
||
#### Maintainer Note (9/15/22) | ||
|
||
|
Oops, something went wrong.