This is the official git repository hosting the source code for the
ScratchJr can be built both for iOS and Android.
A pure-web version is planned to follow at some point in the future.
||Released in App Store
||Released in Google Play
The diagram below illustrates the architecture of ScratchJr and
how the iOS (functional), Android (functional) and pure HTML5 (future)
versions share a common client.
Directory Structure and Projects
This repository has the following directory structure:
editions/ - Assembly directories for each "flavor" of ScratchJr. These symlink to src for common code, and could diverge in settings and assets.
android/ - Android port of Scratch Jr. (Java, Android Studio Projects)
ScratchJr/ - Android Studio Project for ScratchJr Android Application
bin/ - Build scripts and other executables
doc/ - Developer Documentation
ios/ - Xcode project for iOS build. (Make sure to open ScratchJr.xcworkspace not ScratchJr.xcodeproj)
Regardless of whether you are doing iOS development or Android development, you should do these steps.
These instructions assume you are building both versions on Mac OSX, with Homebrew installed.
- Clone or update the code for this repo
- Ensure you have node and npm installed.
- Run sudo easy_install pysvg to install python svg libraries
- Run brew install librsvg to install commandline
- Run brew install imagemagick to install commandline
ScratchJr uses the Firebase SDK to record analytics for the app. Scratch Team developers should look for
the configuration files in the Scratch Devs Vault. If you're not on the Scratch Team, then you'll need to
set up your own app analytics with Google Firebase. It's free. Firebase will generate the configuration files for you to download.
- Place the
google-services.json file in
- Place the
GoogleService-Info.plist file in
- To build the iOS version, you need to have a Mac with Xcode
- Run brew install cocoapods to install CocoaPods
- Run pod install to install the Firebase Analytics dependencies
- Open Xcode
- In Xcode, open ios/ScratchJr.xcworkspace
- Install or update Android Studio
- In Android Studio, open the project android/ScratchJr
- Choose the appropriate flavor/build variant in Android Studio
Note: you can still do Android development on Ubuntu. Instead of the install commands above, run:
sudo easy_install pysvg to install python svg libraries
sudo apt-get install librsvg2-bin to install rsvg-convert
sudo apt-get install imagemagick to install ImageMagick
Where and how to make changes
All changes should be made in a fork. Before making a pull request, ensure all changes pass our linter:
* npm run lint
For more information, see CONTRIBUTING.md.
ScratchJr would not be possible without free and open source libraries, including:
* Yahoo intl-messageformat
ScratchJr is a collaborative effort between: