scratch-www/README.md

47 lines
1.6 KiB
Markdown
Raw Normal View History

2015-09-02 16:33:31 -04:00
## scratch-www
#### Standalone web client for Scratch
2015-09-02 15:08:58 -04:00
2015-09-02 15:11:22 -04:00
[![Build Status](https://magnum.travis-ci.com/LLK/scratch-www.svg?token=xzzHj4ct3SyBTpeqxnx1)](https://magnum.travis-ci.com/LLK/scratch-www)
2015-09-02 15:08:58 -04:00
### To Build
```bash
2015-09-02 16:45:58 -04:00
npm install
npm run build
```
During development, you can use `npm run watch` to cause any update you make to files in either `./static` or `./src` to trigger a rebuild of the project.
### To Run
```bash
2015-09-02 15:08:58 -04:00
npm start
```
2015-10-09 12:57:10 -04:00
or to start and watch at once
```bash
npm run dev
```
2015-09-16 10:40:03 -04:00
Once running, open `http://localhost:8333` in your browser. If you wish to have the server reload automatically, you can install either [nodemon](https://github.com/remy/nodemon) or [forever](https://github.com/foreverjs/forever).
2015-10-09 12:57:10 -04:00
### To stop
```bash
# Stops all `start` and `watch` processes
npm stop
```
#### Configuration
`npm start` and `npm run watch` can be configured with the following environment variables
| Variable | Default | Description |
| ------------- | ------------------------------------- | ---------------------------------------------- |
2015-11-03 10:44:56 -05:00
| `API_HOST` | `https://api.scratch.mit.edu` | Hostname for API requests |
| `NODE_ENV` | `null` | If not `production`, app acts like development |
| `PORT` | `8333` | Port for devserver (http://localhost:XXXX) |
2015-11-03 10:44:56 -05:00
| `PROXY_HOST` | `https://scratch.mit.edu` | Pass-through location for scratchr2 |
2015-09-02 15:08:58 -04:00
### To Test
```bash
npm test
```