scratchfoundation/scratch-www
1
0
Fork 0
mirror of https://github.com/scratchfoundation/scratch-www.git synced 2024-11-23 07:38:07 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
Standalone web client for Scratch
410 commits 218 branches 1 tag 463 MiB
JavaScript 83.4%
SCSS 15.8%
HTML 0.7%
EJS 0.1%
Find a file
Ray Schamp b85775b20f Merge pull request #276 from thisandagain/hotfix/hoc 
Hotfix - Legal fixes for HOC page
2015-12-04 13:01:21 -05:00
lib Move scripts to new lib folder 2015-11-19 10:05:38 -05:00
server Some updates to readme, fallback system 2015-12-03 15:53:51 -05:00
src Merge pull request #276 from thisandagain/hotfix/hoc 2015-12-04 13:01:21 -05:00
static Merge pull request #250 from carljbowman/HOC-Collab-Update 2015-11-20 17:41:59 -05:00
test Move scripts to new lib folder 2015-11-19 10:05:38 -05:00
.eslintrc Add lint exception for formatMessage injection 2015-10-16 11:05:39 -04:00
.gitignore Add deploy make target 2015-11-03 12:51:45 -05:00
.sass-lint.yml Add Global Colors and Updated SCSS / Linter 2015-09-29 11:22:48 -04:00
.travis.yml Truncate commit SHA and use it for BUILD_ARCHIVE 2015-11-02 17:52:30 -05:00
en.json Merge pull request #276 from thisandagain/hotfix/hoc 2015-12-04 13:01:21 -05:00
languages.json Remove fr-ca from language list 2015-12-01 08:44:39 -05:00
Makefile Rename version to tag to match scratch-api 2015-11-20 11:08:42 -05:00
package.json Use webpack-dev-middleware for assets in dev 2015-11-19 15:25:39 -05:00
README.md Some updates to readme, fallback system 2015-12-03 15:53:51 -05:00
webpack.config.js Remove Dedupe plugin from webpack 2015-11-19 15:30:19 -05:00

README.md

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)
PROXY_HOST '' Pass-through location for scratchr2

To Test

npm test

Current issues with the development

We're currently in the process of transitioning into this web client from Scratch's existing structure. As we transition, there are going to be some issues along the way that relate to how this client needs to interact with the existing infrastructure to work properly in production.

On top of migrating to using this as our web client, Scratch is also transitioning into using a new API backend, Scratch REST API. As that is also currently in development and incomplete, we are set up to fall back to using existing Scratch endpoints if an API endpoint does not exist – which is where the PROXY_HOST comes in.

Most of the issues we have currently revolve around the use of PROXY_HOST. This variable is used to specify what url to fall back onto should a request fail within the context of this webclient, or when using the API_HOST. If not specified in the process, it will not be used, and any request that is not made through the web client or the API will be unreachable.

Setting PROXY_HOST=https://scratch.mit.edu allows the web client to retrieve data from the Scratch website in your development environment. However, because of security concerns, trying to send data to Scratch through your development environment won't work. This means the following things will be broken for the time being:

  • Login on the splash page (In the process of being fixed)
  • Some update attempts to production data made through a development version of the web client