scratchfoundation/scratchjr
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratchjr.git synced 2024-11-25 00:28:20 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
With ScratchJr, young children (ages 5-7) can program their own interactive stories and games.
5 commits 73 branches 4 tags 34 MiB
JavaScript 67.1%
Java 11.8%
CSS 9.7%
Objective-C 7.3%
HTML 3.9%
Other 0.2%
Find a file
Tim Mickel 3893b187cf Merge pull request #2 from tmickel/disable-share-setting 
Add setting for disabling sharing UI
2016-01-11 13:50:08 -05:00
.idea Initial commit 2016-01-08 14:31:04 -05:00
.settings Initial commit 2016-01-08 14:31:04 -05:00
android Adding edition resource links to .gitignore 2016-01-08 15:47:13 -05:00
bin Initial commit 2016-01-08 14:31:04 -05:00
doc Initial commit 2016-01-08 14:31:04 -05:00
editions/free Add shareEnabled setting 2016-01-11 13:47:39 -05:00
ios Initial commit 2016-01-08 14:31:04 -05:00
src Don't show sharing UI if sharing is disabled 2016-01-11 13:49:25 -05:00
.esformatter Initial commit 2016-01-08 14:31:04 -05:00
.eslintignore Initial commit 2016-01-08 14:31:04 -05:00
.eslintrc Initial commit 2016-01-08 14:31:04 -05:00
.gitignore Initial commit 2016-01-08 14:31:04 -05:00
.project Initial commit 2016-01-08 14:31:04 -05:00
package.json Initial commit 2016-01-08 14:31:04 -05:00
README.md Initial commit 2016-01-08 14:31:04 -05:00

README.md

Overview

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

ScratchJr cannot be copied and/or distributed without the express permission of the Massachusetts Institute of Technology (MIT). You should only access this repository if you have been given explicit permission from MIT.

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

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

Release Schedule

As of this writing, the Android version now supports Android 4.2 and above.

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 Javasript 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.

Building ScratchJr

To build the Android version, you need to have a system equipped with Android Studio. To build the iOS version, you need to have a Mac with XCode.

The build caches .png files out of the .svg files to improve performance. To enable this build step, you need to install a few dependencies.

On Ubuntu:

  • Run sudo easy_install pysvg to install python svg libraries
  • Run sudo apt-get install librsvg2-bin to install rsvg-convert
  • Run sudo apt-get install imagemagick to install ImageMagick

On OS X:

  • Install Homebrew.
  • Run sudo easy_install pysvg to install python svg libraries
  • Run brew install librsvg to install rsvg-convert
  • Run brew install imagemagick to install ImageMagick

Once these are installed, select the appropriate target in XCode or the appropriate flavor/build variant in Android Studio.

Code credits

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

Acknowledgments

ScratchJr is a collaborative effort between: