generator-colyseus-gcp

generator-colyseus-gcp

Simple colyseus gcp project template.

Using Yeoman

To find out more about Yeoman, check out the documentation.

Getting Started

Before we get started this yeoman generator assumes you know how to use npm, yarn and node. This project template uses version 2 of yarn mostly for speed but it can be frustrating to work with.

• Install yeoman aka yo.

$ yarn global add yo

• Install generator-colyseus-gcp.

$ yarn global add generator-colyseus-gcp

• Create project with generator!

$ mkdir my-colyseus-gcp-project
$ cd my-colyseus-gcp-project && yo generator-colyseus-gcp

Usage

The project is setup with an app/client, app/server, and packages.

• Build project.

yarn workspace @appName/contract build
yarn workspace @appName/server build
yarn workspace @appName/client build

• Run the server and client.

yarn workspace @appName/server start
yarn workspace @appName/client start

• Deploy the projects to GCP and Netlify. Make sure to replace gcpServerLocation with the GCP server address (ie wss://my-cool-app.appspot.com/)

yarn workspace @appName/server deploy
NODE_ENV=production __SERVER_HOST=gcpServerLocation yarn workspace @appName/client deploy

License

The MIT License

Copyright (c) 2020, nate-wilkins

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.