Skip to content
Snippets Groups Projects
README.md 1.28 KiB
Newer Older
Ray Schamp's avatar
Ray Schamp committed
# scratch-gui
#### Scratch GUI is a set of React components that comprise the interface for creating and running Scratch 3.0 projects

Ray Schamp's avatar
Ray Schamp committed
[![Build Status](https://travis-ci.com/LLK/scratch-gui.svg?token=Yfq2ryN1BwaxDME69Lnc&branch=master)](https://travis-ci.com/LLK/scratch-gui)
Ray Schamp's avatar
Ray Schamp committed
[![Greenkeeper badge](https://badges.greenkeeper.io/LLK/scratch-gui.svg)](https://greenkeeper.io/)
Ray Schamp's avatar
Ray Schamp committed

Ray Schamp's avatar
Ray Schamp committed
## Installation
This requires you to have Git and Node.js installed.

In your own node environment/application:
```bash
npm install https://github.com/LLK/scratch-gui.git
```
If you want to edit/play yourself:
```bash
git clone git@github.com:LLK/scratch-gui.git
cd scratch-gui
npm install
```

## Getting started
Running the project requires Node.js to be installed.
Ray Schamp's avatar
Ray Schamp committed

## Running
Ray Schamp's avatar
Ray Schamp committed
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

## Testing
```bash
npm test
Ray Schamp's avatar
Ray Schamp committed
```

## Donate
We provide [Scratch](https://scratch.mit.edu) free of charge, and want to keep it that way! Please consider making a [donation](https://secure.donationpay.org/scratchfoundation/) to support our continued engineering, design, community, and resource development efforts. Donations of any size are appreciated. Thank you!