mirror of
https://github.com/scratchfoundation/scratch-www.git
synced 2024-11-22 23:27:54 -05:00
d630efb23c
So that it's clear to newcomers what things are not yet completed in scratch-www as we build it out.
42 lines
1.8 KiB
Markdown
42 lines
1.8 KiB
Markdown
## scratch-www
|
|
#### Standalone web client for Scratch
|
|
|
|
[](https://magnum.travis-ci.com/LLK/scratch-www)
|
|
|
|
### To Build
|
|
```bash
|
|
npm install
|
|
npm run build
|
|
```
|
|
|
|
### To Run
|
|
```bash
|
|
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](https://github.com/remy/nodemon) or [forever](https://github.com/foreverjs/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
|
|
```bash
|
|
npm test
|
|
```
|