Giter Club home page Giter Club logo

pixelrun's Introduction

Pixel-Run

Build Status

Pixel-Run is a jump and run game developed and maintained by Namics' trainees.

Run

To run the pixel run server you first have to build the client application. There is a server running Express which serves the game app and handles the scores sent by the game in the browser.

Install

To install and run the game on your by your own clone this repository and install all dependencies.

yarn install

Env variables to set

Some environmental variables are needed in order to build the game.

Key Value
HOST (required) the local hostname
JUMP_ON (required) push to jump on keypress and release to jump on keyup
PORT Port default is 3000

Build

To build for production use the build task.

yarn build

Start Server

To start the server run the command

yarn start

Before starting the live server you have the build the React app otherwise nothing is displayed.

Contributing

Development Server

For development there is a dev task which runs webpack with a watcher side by side with the express server.

yarn dev

For development build only use the build:dev task

yarn build:dev

Run tests

To run the Jest tests run

 yarn test

pixelrun's People

Contributors

realjaypkay2 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.