Raspsnir/public_html/browserquest/README.md

23 lines
834 B
Markdown
Raw Normal View History

BrowserQuest client documentation
=================================
The client directory should never be directly deployed to staging/production. Deployment steps:
1) Configure the websocket host/port:
In the client/config/ directory, copy config_build.json-dist to a new config_build.json file.
Edit the contents of this file to change host/port settings.
2) Run the following commands from the project root:
(Note: nodejs is required to run the build script)
* cd bin
* chmod +x build.sh
* ./build.sh
This will use the RequireJS optimizer tool to create a client-build/ directory containing a production-ready version of BrowserQuest.
A build log file will also be created at bin/build.txt.
The client-build directory can be renamed and deployed anywhere. It has no dependencies to any other file/folder in the repository.