base on Graphical User Interface for creating and running Scratch 3.0 projects. # scratch-gui Scratch GUI is a set of React components that comprise the interface for creating and running Scratch 3.0 projects To open the current build in your browser on Github Pages: https://scratchfoundation.github.io/scratch-gui/ ## Installation This requires you to have Git and Node.js installed. In your own node environment/application: ```bash npm install https://github.com/scratchfoundation/scratch-gui.git ``` If you want to edit/play yourself: ```bash git clone https://github.com/scratchfoundation/scratch-gui.git cd scratch-gui npm install ``` **You may want to add `--depth=1` to the `git clone` command because there are some [large files in the git repository history](https://github.com/scratchfoundation/scratch-gui/issues/5140).** ## Getting started Running the project requires Node.js to be installed. ## Running Open a Command Prompt or Terminal in the repository and run: ```bash npm start ``` Then go to [http://localhost:8601/](http://localhost:8601/) - the playground outputs the default GUI component ## Developing alongside other Scratch repositories ### Getting another repo to point to this code If you wish to develop `scratch-gui` alongside other scratch repositories that depend on it, you may wish to have the other repositories use your local `scratch-gui` build instead of fetching the current production version of the scratch-gui that is found by default using `npm install`. Here's how to link your local `scratch-gui` code to another project's `node_modules/scratch-gui`. #### Configuration 1. In your local `scratch-gui` repository's top level: 1. Make sure you have run `npm install` 2. Build the `dist` directory by running `BUILD_MODE=dist npm run build` 3. Establish a link to this repository by running `npm link` 2. From the top level of each repository (such as `scratch-www`) that depends on `scratch-gui`: 1. Make sure you have run `npm install` 2. Run `npm link scratch-gui` 3. Build or run the repository #### Using `npm run watch` Instead of `BUILD_MODE=dist npm run build`, you can use `BUILD_MODE=dist npm run watch` instead. This will watch for changes to your `scratch-gui` code, and automatically rebuild when there are changes. Sometimes this has been unreliable; if you are having problems, try going back to `BUILD_MODE=dist npm run build` until you resolve them. #### Oh no! It didn't work! If you can't get linking to work right, try: * Follow the recipe above step by step and don't change the order. It is especially important to run `npm install` _before_ `npm link` as installing after the linking will reset the linking. * Make sure the repositories are siblings on your machine's file tree, like `.../.../MY_SCRATCH_DEV_DIRECTORY/scratch-gui/` and `.../.../MY_SCRATCH_DEV_DIRECTORY/scratch-www/`. * Consistent node.js version: If you have multiple Terminal tabs or windows open for the different Scratch repositories, make sure to use the same node version in all of them. * If nothing else works, unlink the repositories by running `npm unlink` in both, and start over. ## Testing ### Documentation You may want to review the documentation for [Jest](https://facebook.github.io/jest/docs/en/api.html) and [Enzyme](http://airbnb.io/enzyme/docs/api/) as you write your tests. See [jest cli docs](https://facebook.github.io/jest/docs/en/cli.html#content) for more options. ### Running tests *NOTE: If you're a Windows user, please run these scripts in Windows `cmd.exe` instead of Git Bash/MINGW64.* Before running any tests, make sure you have run `npm install` from this (scratch-gui) repository's top level. #### Main testing command To run linter, unit tests, build, and integration tests, all at once: ```bash npm test ``` #### Running unit tests To run unit tests in isolation: ```bash npm run test:unit ``` To run unit tests in watch mode (watches for code changes and continuously runs tests): ```bash npm run test:unit -- --watch ``` You can run a single file of integration tests (in this example, the `button` tests): ```bash $(npm bin)/jest --runInBand test/unit/components/button.test.jsx ``` #### Running integration tests Integration tests use a headless browser to manipulate the actual HTML and javascript that the repo produces. You will not see this activity (though you can hear it when sounds are played!). To run the integration tests, you'll first need to install Chrome, Chromium, or a variant, along with Chromedriver. Note that integration tests require you to first create a build that can be loaded in a browser: ```bash npm run build ``` Then, you can run all integration tests: ```bash npm run test:integration ``` Or, you can run a single file of integration tests (in this example, the `backpack` tests): ```bash $(npm bin)/jest --runInBand test/integration/backpack.test.js ``` If you want to watch the browser as it runs the test, rather than running headless, use: ```bash USE_HEADLESS=no $(npm bin)/jest --runInBand test/integration/backpack.test.js ``` ## Troubleshooting ### Ignoring optional dependencies When running `npm install`, you can get warnings about optional dependencies: ```text npm WARN optional Skipping failed optional dependency /chokidar/fsevents: npm WARN notsup Not compatible with your operating system or architecture: [email protected] ``` You can suppress them by adding the `no-optional` switch: ```bash npm install --no-optional ``` Further reading: [Stack Overflow](https://stackoverflow.com/questions/36725181/not-compatible-with-your-operating-system-or-architecture-fsevents1-0-11) ### Resolving dependencies When installing for the first time, you can get warnings that need to be resolved: ```text npm WARN [email protected] requires a peer of babel-eslint@^8.0.1 but none was installed. npm WARN [email protected] requires a peer of eslint@^4.0 but none was installed. npm WARN [email protected] requires a peer of react-intl-redux@^0.7 but none was installed. npm WARN [email protected] requires a peer of react-responsive@^4 but none was installed. ``` You can check which versions are available: ```bash npm view react-intl-redux@0.* version ``` You will need to install the required version: ```bash npm install --no-optional --save-dev react-intl-redux@^0.7 ``` The dependency itself might have more missing dependencies, which will show up like this: ```bash user@machine:~/sources/scratch/scratch-gui (491-translatable-library-objects)$ npm install --no-optional --save-dev react-intl-redux@^0.7 [email protected] /media/cuideigin/Linux/sources/scratch/scratch-gui ├── [email protected] └── UNMET PEER DEPENDENCY [email protected] ``` You will need to install those as well: ```bash npm install --no-optional --save-dev react-responsive@^5.0.0 ``` Further reading: [Stack Overflow](https://stackoverflow.com/questions/46602286/npm-requires-a-peer-of-but-all-peers-are-in-package-json-and-node-modules) ## Troubleshooting If you run into npm install errors, try these steps: 1. run `npm cache clean --force` 2. Delete the node_modules directory 3. Delete package-lock.json 4. run `npm install` again ## Publishing to GitHub Pages You can publish the GUI to github.io so that others on the Internet can view it. [Read the wiki for a step-by-step guide.](https://github.com/scratchfoundation/scratch-gui/wiki/Publishing-to-GitHub-Pages) ## Understanding the project state machine Since so much code throughout scratch-gui depends on the state of the project, which goes through many different phases of loading, displaying and saving, we created a "finite state machine" to make it clear which state it is in at any moment. This is contained in the file src/reducers/project-state.js . It can be hard to understand the code in src/reducers/project-state.js . There are several types of data and functions used, which relate to each other: ### Loading states These include state constant strings like: * `NOT_LOADED` (the default state), * `ERROR`, * `FETCHING_WITH_ID`, * `LOADING_VM_WITH_ID`, * `REMIXING`, * `SHOWING_WITH_ID`, * `SHOWING_WITHOUT_ID`, * etc. ### Transitions These are names for the action which causes a state change. Some examples are: * `START_FETCHING_NEW`, * `DONE_FETCHING_WITH_ID`, * `DONE_LOADING_VM_WITH_ID`, * `SET_PROJECT_ID`, * `START_AUTO_UPDATING`, ### How transitions relate to loading states Like this diagram of the project state machine shows, various transition actions can move us from one loading state to another:  _Note: for clarity, the diagram above excludes states and transitions relating to error handling._ #### Example Here's an example of how states transition. Suppose a user clicks on a project, and the page starts to load with URL `https://scratch.mit.edu/projects/123456`. Here's what will happen in the project state machine:  1. When the app first mounts, the project state is `NOT_LOADED`. 2. The `SET_PROJECT_ID` redux action is dispatched (from src/lib/project-fetcher-hoc.jsx), with `projectId` set to `123456`. This transitions the state from `NOT_LOADED` to `FETCHING_WITH_ID`. 3. The `FETCHING_WITH_ID` state. In src/lib/project-fetcher-hoc.jsx, the `projectId` value `123456` is used to request the data for that project from the server. 4. When the server responds with the data, src/lib/project-fetcher-hoc.jsx dispatches the `DONE_FETCHING_WITH_ID` action, with `projectData` set. This transitions the state from `FETCHING_WITH_ID` to `LOADING_VM_WITH_ID`. 5. The `LOADING_VM_WITH_ID` state. In src/lib/vm-manager-hoc.jsx, we load the `projectData` into Scratch's virtual machine ("the vm"). 6. When loading is done, src/lib/vm-manager-hoc.jsx dispatches the `DONE_LOADING_VM_WITH_ID` action. This transitions the state from `LOADING_VM_WITH_ID` to `SHOWING_WITH_ID`. 7. The `SHOWING_WITH_ID` state. Now the project appears normally and is playable and editable. ## Donate We provide [Scratch](https://scratch.mit.edu) free of charge, and want to keep it that way! Please consider making a [donation](https://www.scratchfoundation.org/donate) to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you! ", Assign "at most 3 tags" to the expected json: {"id":"4921","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"