You'll need Node.js installed. Then:
- Fork and/or clone this repository and
cdinto the project's directory - Run
npm installto install the project's dependencies - Run
npm run start-devto build and serve the game
The project is configured to deploy (and is deployed) to Firebase:
- Run
npm run deploy-initand...- Provide login credentials
- Select
Hosting Create a new projector, if you've set one up already,Use an existing project, then follow the prompts until...- Use
distas your public directory - The remainder of the configuration choices are unimportant, so feel free to use defaults
- Run
npm run deployto build and deploy to Firebase
Phrogger is built using only the Canvas API without any frameworks. The only module bundled in with the app is Web Font Loader to handle loading a Google Fonts typeface before the game runs.
Dev dependencies also include:
- ESLint
- Responsible for yelling at you when your code is problematic. I highly recommend using it when working in JavaScript. I use Visual Studio Code with ESLint and Error Lens extensions.
- Firebase CLI
- For deployment in this project
- Live Server
- To serve the game and automatically reload upon saving when in development
- webpack
- To bundle, minify and inline the JavaScript and CSS code into
index.html
- To bundle, minify and inline the JavaScript and CSS code into