scratch-www/README.md
Matthew Taylor d630efb23c Add shouldFallback process env variable
So that it's clear to newcomers what things are not yet completed in scratch-www as we build it out.
2015-12-03 10:44:47 -05:00

1.8 KiB

scratch-www

Standalone web client for Scratch

Build Status

To Build

npm install
npm run build

To Run

npm start

During development, npm start watches any update you make to files in either ./static or ./src and triggers a rebuild of the project. In development the build is stored in memory, and not served from the ./build directory.

Once running, open http://localhost:8333 in your browser. If you wish to have the server reload automatically, you can install either nodemon or forever.

To stop

Use ^C to stop the node process npm start starts.

Configuration

npm start can be configured with the following environment variables

Variable Default Description
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)
FALLBACK false Whether or not to fallback to PROXY_HOST for non-existent pages/reqeusts
PROXY_HOST https://scratch.mit.edu Pass-through location for scratchr2

Current issues with the development

  • Login does not work (In the process of being fixed)

To Test

npm test