Skip to content
This repository has been archived by the owner on Aug 12, 2022. It is now read-only.

Latest commit

 

History

History
96 lines (70 loc) · 4.38 KB

README.md

File metadata and controls

96 lines (70 loc) · 4.38 KB
Raw

Overview

This is the official git repository hosting the source code for the ScratchJr project.

ScratchJr can be built both for iOS and Android. A pure-web version is planned to follow at some point in the future.

Platform Status
iOS Released in App Store
Android Released in Google Play

Architecture Overview

The diagram below illustrates the architecture of ScratchJr and how the iOS (functional), Android (functional) and pure HTML5 (future) versions share a common client.

Scratch Jr. Architecture Diagram

Directory Structure and Projects

This repository has the following directory structure:

  • src/ - Shared JavaScript code for iOS and Android common client. This is where most changes should be made for features, bug fixes, UI, etc.
  • editions/ - Assembly directories for each "flavor" of ScratchJr. These symlink to src for common code, and could diverge in settings and assets.
    • free/ - Free edition JavaScript, including all shared code for all releases
  • 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)

Building ScratchJr

Initial setup

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.

  1. Clone or update the code for this repo
  2. Ensure you have node and npm installed.
  3. Run sudo easy_install pysvg to install python svg libraries
  4. Run brew install librsvg to install commandline rsvg-convert
  5. Run brew install imagemagick to install commandline magick
  6. In the top level of the scratchjr repo directory, install npm dependencies for bundling the JavaScript: npm install

Analytics

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.

  1. Place the google-services.json file in editions/free/android-resources
  2. Place the GoogleService-Info.plist file in editions/free/ios-resources

iOS

  1. To build the iOS version, you need to have a Mac with Xcode
  2. Run brew install cocoapods to install CocoaPods
  3. Run pod install to install the Firebase Analytics dependencies
  4. Open Xcode
  5. In Xcode, open ios/ScratchJr.xcworkspace

Android

  1. Install or update Android Studio
  2. In Android Studio, open the project android/ScratchJr
  3. 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:

  1. sudo easy_install pysvg to install python svg libraries
  2. sudo apt-get install librsvg2-bin to install rsvg-convert
  3. 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.

Code credits

ScratchJr would not be possible without free and open source libraries, including:

Acknowledgments

ScratchJr is a collaborative effort between: