Skip to content

luisvinicius09/shooterJS

Repository files navigation

ShooterJS

This is a simple space shooter built with Phaser.js.

The game design document can be found here.

Built With

  • Phaser.js
  • HTML & CSS
  • Javascript

Live Demo

Live Demo

Getting Started

This is how you set up your project locally.

To get a local copy up and running follow these simple example steps.

Prerequisites

  • Code editor.

  • Node.js installed.

  • OPTIONAL: Yarn installed.

Setup

  • The first step you need, is download or clone the repo to your local machine.

Install

  • To install the dependecies, just run npm install or yarn build (if you got yarn) on your console/terminal.

Usage

To open the project in your local machine, there is a few ways you can do that, but you will need a server to run the project.

  • If you are using VS Code, you can use the live server extension on the index.html in the build folder by clicking with the right button of the mouse and selecting Open with Live Server.

  • If you are not using VS Code, you can run npm run server on your console/terminal. It'll give you an url that you can access through your browser and play game.

  • If you want to make modifications on the project you will also need to open another window of the console/terminal and run npm run build(one time) and npm run watch(if you want to modify multiple things and just reload the browser to see them).

Run tests

  • To run test use npm run jest or yarn test on the console/terminal

Deployment

The deploy of this project was made in Netfily, but you can use any website that you want.

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc

📝 License

This project is MIT licensed.

Author(s)

Author1 👤

GitHub: @luisvinicius09

LinkedIn: LinkedIn

About

Space shooter built with Phaser.js.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published