684038a948 | ||
---|---|---|
addon | ||
bin | ||
embedded | ||
htmlshot | ||
src | ||
vendor | ||
.gitignore | ||
README.md | ||
index.html | ||
main.js | ||
package.json | ||
reference.html | ||
require-config.js |
README.md
webmaker-addons
Prototypes for add-ons that serve as a gateway from browser to Webmaker.
Quick Start
Working on the project just requires a web server that serves
static files from the root of the repository. If you don't have
one, try python -m SimpleHTTPServer
, or if you like node use
http-server.
If you want to develop offline, add ?bin=offline
to the end of
your URL. This will prevent the app from syncing with Firebase.
That said, some things that require a network connection, like
Google Fonts, won't work.
Configuration
A number of configuration defaults are contained in
require-config.js
. If you want to change these, make a file
alongside it called require-config.local.js
. Any changes you make
to configuration variables/objects in this file will take effect
before the app initializes.
HTML Screenshot Service
An HTML screenshot service used to render a user's creation to a PNG
is located in the htmlshot
directory. See htmlshot/README.md for
more details.
Firefox Add-on
An experimental Firefox add-on that embeds this tool in a sidebar is
located in the addon
directory.
To develop on it, install the Add-on SDK, activate it, and run the following from the root directory of this repository:
export WEBMAKER_ADDON_IFRAME_URL=http://localhost:8080/
cd addon
cfx run
The above assumes your static web server is running on port 8080. If it's
not, change WEBMAKER_ADDON_IFRAME_URL
accordingly.
You can also run the add-on's test suite with cfx test
.