https://github.com/marmelab/bug-slayer
A marmelab game about a developer fighting bugs
https://github.com/marmelab/bug-slayer
Last synced: 4 months ago
JSON representation
A marmelab game about a developer fighting bugs
- Host: GitHub
- URL: https://github.com/marmelab/bug-slayer
- Owner: marmelab
- License: mit
- Created: 2022-06-08T08:59:17.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-09T15:42:49.000Z (over 1 year ago)
- Last Synced: 2025-02-17T02:53:24.625Z (4 months ago)
- Language: TypeScript
- Size: 6.07 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Phaser 3 Webpack Project Template
A Phaser 3 project template with ES6 support via [Babel 8](https://babeljs.io/) and [Webpack 5](https://webpack.js.org/) that includes hot-reloading for development and production-ready builds.
This has been updated for Phaser 3.55.2 version and above.
Loading images via JavaScript module `import` is also supported, although not recommended.
## Requirements
[Node.js](https://nodejs.org) is required to install dependencies and run scripts via `npm`.
## Available Commands
| Command | Description |
| -------------- | ------------------------------------------------------------------------------- |
| `make install` | Install project dependencies |
| `make start` | Build project and open web server running project |
| `make build` | Builds code bundle with production settings (minification, uglification, etc..) |
| `make lint` | Lint the code and fix auto-fixable errors |
| `make format` | Run prettier to format the code |
## Writing Code
After cloning the repo, run `make install` from your project directory. Then, you can start the local development server by running `make start`.
After starting the development server with `make start`, you can edit any files in the `src` folder and webpack will automatically recompile and reload your server (available at `http://localhost:8080` by default).
## Customizing the Template
### Babel
You can write modern ES6+ JavaScript and Babel will transpile it to a version of JavaScript that you want your project to support. The targeted browsers are set in the `.babelrc` file and the default currently targets all browsers with total usage over "0.25%" but excludes IE11 and Opera Mini.
```
"browsers": [
">0.25%",
"not ie 11",
"not op_mini all"
]
```
### Webpack
If you want to customize your build, such as adding a new webpack loader or plugin (i.e. for loading CSS or fonts), you can modify the `webpack/base.js` file for cross-project changes, or you can modify and/or create new configuration files and target them in specific npm tasks inside of `package.json'.
## Deploying Code
After you run the `make run build` command, your code will be built into a single bundle located at `dist/bundle.min.js` along with any other assets you project depended.
If you put the contents of the `dist` folder in a publicly-accessible location (say something like `http://mycoolserver.com`), you should be able to open `http://mycoolserver.com/index.html` and play your game.