We're modifying the https://github.com/LLK/scratch-gui repository to make Scratch gui work for small screen. Kindly help with the issues to make this a success for all the learners.
Scratch GUI is a set of React components that comprise the interface for creating and running Scratch 3.0 projects
This requires you to have Git and Node.js installed.
Please use Node.js 16.13.0
for setting up and running the same. If you are using a higher version, use nvm.
git clone https://github.com/navgurukul/scratch.git --depth=1
cd scratch-gui
npm install
Open a Command Prompt or Terminal in the repository and run:
npm start
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.
Then go to http://localhost:8601/ - the playground outputs the default GUI component
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
.
-
In your local
scratch-gui
repository's top level:- Make sure you have run
npm install
- Build the
dist
directory by runningBUILD_MODE=dist npm run build
- Establish a link to this repository by running
npm link
- Make sure you have run
-
From the top level of each repository (such as
scratch-www
) that depends onscratch-gui
:- Make sure you have run
npm install
- Run
npm link scratch-gui
- Build or run the repository
- Make sure you have run
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
beforenpm 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.
You may want to review the documentation for Jest and Enzyme as you write your tests.
See jest cli docs for more options.
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.
To run linter, unit tests, build, and integration tests, all at once:
npm test
To run unit tests in isolation:
npm run test:unit
To run unit tests in watch mode (watches for code changes and continuously runs tests):
npm run test:unit -- --watch
You can run a single file of integration tests (in this example, the button
tests):
$(npm bin)/jest --runInBand test/unit/components/button.test.jsx
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!).
Note that integration tests require you to first create a build that can be loaded in a browser:
npm run build
Then, you can run all integration tests:
npm run test:integration
Or, you can run a single file of integration tests (in this example, the backpack
tests):
$(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:
USE_HEADLESS=no $(npm bin)/jest --runInBand test/integration/backpack.test.js
When running npm install
, you can get warnings about optional dependencies:
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:
npm install --no-optional
Further reading: Stack Overflow
When installing for the first time, you can get warnings that need to be resolved:
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:
npm view react-intl-redux@0.* version
You will need to install the required version:
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:
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:
npm install --no-optional --save-dev react-responsive@^5.0.0
Further reading: Stack Overflow
If you run into npm install errors, try these steps:
- run
npm cache clean --force
- Delete the node_modules directory
- Delete package-lock.json
- run
npm install
again
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.
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:
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.
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
,
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.
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:
- When the app first mounts, the project state is
NOT_LOADED
. - The
SET_PROJECT_ID
redux action is dispatched (from src/lib/project-fetcher-hoc.jsx), withprojectId
set to123456
. This transitions the state fromNOT_LOADED
toFETCHING_WITH_ID
. - The
FETCHING_WITH_ID
state. In src/lib/project-fetcher-hoc.jsx, theprojectId
value123456
is used to request the data for that project from the server. - When the server responds with the data, src/lib/project-fetcher-hoc.jsx dispatches the
DONE_FETCHING_WITH_ID
action, withprojectData
set. This transitions the state fromFETCHING_WITH_ID
toLOADING_VM_WITH_ID
. - The
LOADING_VM_WITH_ID
state. In src/lib/vm-manager-hoc.jsx, we load theprojectData
into Scratch's virtual machine ("the vm"). - When loading is done, src/lib/vm-manager-hoc.jsx dispatches the
DONE_LOADING_VM_WITH_ID
action. This transitions the state fromLOADING_VM_WITH_ID
toSHOWING_WITH_ID
- The
SHOWING_WITH_ID
state. Now the project appears normally and is playable and editable.
Original code is licensed under BSD 3-Clause "New" or "Revised" License. Any modification in this repository is under GPL license.
We provide Scratch free of charge, and want to keep it that way! Please consider making a donation to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!