phaser-app-template

A template for a Phaser app.

Development Instructions

1. create a new repository using this template
2. edit package.json as needed
3. execute npm install to install the project dependencies
4. execute npm run serve to start a development server on port 8000
5. create your app

Note: If you want to create a README.md file for your project, rename this one to something like README-template.md and create a new README.md file.

Deployment Instructions

GitHub Pages

1. create a gh-pages branch
2. goto the Settings page for your project
3. click the Actions > General tab
4. check the Read and write permissions option under Workflow permissions
5. open src/ghp-index.html and change the base URL to https://<your_github_username>.github.io/<repository_name>/
6. your project will be automatically built and deployed to GitHub Pages whenever you push to the main branch
7. visit https://<your_github_username>.github.io/<repository_name>/ to view your live project

Note: The dist folder must remain excluded from .gitignore in order for the deployment workflow to succeed.

Other

1. execute npm run build
2. copy the contents of dist/ to a web server