https://github.com/frotty/gelatus

https://github.com/frotty/gelatus

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/frotty/gelatus
• Owner: Frotty
• License: mit
• Created: 2021-07-16T00:43:12.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-06T13:10:03.000Z (7 months ago)
• Last Synced: 2024-06-06T14:45:31.022Z (7 months ago)
• Language: TypeScript
• Size: 4.73 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Gelatus Mono Repo

- Frontend using Typescript and Phaser

- Backend using Typescript and Express + Socket.io

## Prerequisites

Make sure you have node.js Version 14+ installed

Run `npm i` to install dependencies.

## Running the Frontend

Run `npm run start:dev` for a live reload frontend instance.

A browser tab should open at `localhost:8080`.

## Running the backend

Run `npm run server:dev` to compile the backend to javascript and run that with node. No live reload currently.

## How to Build the Site

Run `npm run build` after modifying code to populate the **public** directory with the final site contents.

This is required for sharing the frontend with other players. After building the app use

`npm run ngrok`

Which will give you a URL where other players can connect to.

## Upgrading Phaser

To upgrade Phaser 3 run `npm upgrade phaser`.