-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Using React to create a shell around the Emscripten version of Drawdance.
- Loading branch information
1 parent
3de7fd7
commit c13cf9c
Showing
68 changed files
with
65,906 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
||
# dependencies | ||
/node_modules | ||
/.pnp | ||
.pnp.js | ||
|
||
# testing | ||
/coverage | ||
|
||
# production | ||
/build | ||
|
||
# misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
build | ||
node_modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
{} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# NAME | ||
|
||
drawdance\_web - React-based Web Interface for Drawdance | ||
|
||
# SYNOPSIS | ||
|
||
First, run `npm install --include=dev` to install node dependencies. | ||
|
||
For development: | ||
|
||
- Build the application for Emscripten. | ||
|
||
- Start the [drawdance-server-proxy](../../server) and point it at the build directory. | ||
|
||
- Edit the [drawdance-config.js](public/drawdance-config.js) and set the `targetUrl` to `ws://localhost:27751`. | ||
|
||
- Run `npm start` in this directory to start the development server. | ||
|
||
For production: | ||
|
||
- Build the application for Emscripten in release mode. | ||
|
||
- Run `npm run build` in this directory. The resulting directory will be called `build`. | ||
|
||
- Copy `drawdance.{data,js,wasm,worker.js}` from the Emscripten build directory into `build`. | ||
|
||
# DESCRIPTION | ||
|
||
This is a web frontend for Drawdance. It's built on React and acts as a shell around the Emscripten build of Drawdance. | ||
|
||
Like Drawdance, it's currently only built for watching, not drawing yourself. It requires a browser that supports SharedArrayBuffer, since Drawdance runs on multiple threads. | ||
|
||
For deploying this in production, you probably need a TLS certificate. When SharedArrayBuffer is involved, browsers only allow WebSocket connections under localhost unsecured, all other domains need to be HTTPS/WSS secured. | ||
|
||
To generate the [third-party license attributions](attribution.txt), [oss-attribution-generator](https://github.com/zumwald/oss-attribution-generator) is used. You should run it after modifying the dependencies to keep that document up to date. | ||
|
||
# LICENSE | ||
|
||
Drawdance is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. See the [LICENSE file](../../LICENSE) for the full license text. | ||
|
||
The drawdance\_web code itself is licensed under the MIT license. See the [LICENSE-FOR-ORIGINAL-CODE file](../LICENSE-FOR-ORIGINAL-CODE) for the full license text. | ||
|
||
# SEE ALSO | ||
|
||
- [The Drawdance README](../../README.md) | ||
|
||
- [The drawdance-server-proxy README](../../server/README.md) |
Oops, something went wrong.