11# scratch-gui
22
3- Scratch GUI is a set of React components that comprise the interface for creating and running Scratch 3.0 projects
3+ ## ** ⚠️ NOTICE: Repository Migration to Mono-Repo ⚠️**
4+
5+ The Scratch Team has migrated the ` scratch-gui ` module into a new mono-repo,
6+ [ ` scratch-editor ` ] ( https://github.com/scratchfoundation/scratch-editor ) . This independent ` scratch-gui ` repository
7+ ** will be archived** . Any new issues or pull requests should be opened in the mono-repo.
8+
9+ The new mono-repo version of ` scratch-gui ` is published to the NPM registry as
10+ [ ` @scratch/scratch-gui ` ] ( https://www.npmjs.com/package/@scratch/scratch-gui ) .
11+
12+ ** Contributors:**
13+
14+ * I would like to thank all past contributors for their work on this repository.
15+ * If you are aware of valuable issues or pull requests, please consider re-opening them in the mono-repo. If you do
16+ so, please link the new issue or pull request to the original one in this repository to help others find it and to
17+ reduce the chance of duplicate work.
18+ * We apologize for the inconvenience and greatly appreciate your help with this transition!
19+
20+ For more information, see the [ ` scratch-editor ` repository on GitHub] ( https://github.com/scratchfoundation/scratch-editor ) .
21+
22+ ## Overview
23+
24+ Scratch GUI is a set of React components that comprise the interface for creating and running Scratch 3.0 projects.
425
526To open the current build in your browser on Github Pages:
627
7- https://scratchfoundation.github.io/scratch-gui/
28+ < https://scratchfoundation.github.io/scratch-gui/ >
829
930## Installation
1031
@@ -45,7 +66,6 @@ Then go to [http://localhost:8601/](http://localhost:8601/) - the playground out
4566
4667### Getting another repo to point to this code
4768
48-
4969If you wish to develop ` scratch-gui ` alongside other scratch repositories that depend on it, you may wish
5070to have the other repositories use your local ` scratch-gui ` build instead of fetching the current production
5171version of the scratch-gui that is found by default using ` npm install ` .
@@ -70,7 +90,7 @@ Instead of `BUILD_MODE=dist npm run build`, you can use `BUILD_MODE=dist npm run
7090changes to your ` scratch-gui ` code, and automatically rebuild when there are changes. Sometimes this has been
7191unreliable; if you are having problems, try going back to ` BUILD_MODE=dist npm run build ` until you resolve them.
7292
73- #### Oh no! It didn't work!
93+ #### Oh no! It didn't work
7494
7595If you can't get linking to work right, try:
7696
@@ -93,7 +113,7 @@ See [jest cli docs](https://facebook.github.io/jest/docs/en/cli.html#content) fo
93113
94114### Running tests
95115
96- * NOTE : If you're a Windows user, please run these scripts in Windows ` cmd.exe ` instead of Git Bash/MINGW64.*
116+ _ NOTE : If you're a Windows user, please run these scripts in Windows ` cmd.exe ` instead of Git Bash/MINGW64._
97117
98118Before running any tests, make sure you have run ` npm install ` from this (scratch-gui) repository's top level.
99119
@@ -215,15 +235,6 @@ npm install --no-optional --save-dev react-responsive@^5.0.0
215235
216236Further reading: [ Stack Overflow] ( https://stackoverflow.com/questions/46602286/npm-requires-a-peer-of-but-all-peers-are-in-package-json-and-node-modules )
217237
218- ## Troubleshooting
219-
220- If you run into npm install errors, try these steps:
221-
222- 1 . run ` npm cache clean --force `
223- 2 . Delete the node_modules directory
224- 3 . Delete package-lock.json
225- 4 . run ` npm install ` again
226-
227238## Publishing to GitHub Pages
228239
229240You can publish the GUI to github.io so that others on the Internet can view it.
0 commit comments