NewcastleRSE/gaming-and-gambling

Gaming and Gambling

This repository contains the code for three web based games, viewable/playable on a mobile phone. The aim of the first game is to teach children and parents about the mechanics of gambling style games such as loot boxes.

About

Project Team

• Dr James Ash, Senior Lecturer, Newcastle University, (james.ash@newcastle.ac.uk)
• Dr Rachel Gordon, Research Associate, Newcastle University, (rachel.gordon@newcastle.ac.uk)
• Dr Sarah Mills, Reader in Human Geography, Loughborough University, (s.mills@lboro.ac.uk)

RSE Contact

Dr. Jannetta Steyn RSE Team
Newcastle University
(jannetta.steyn@newcastle.ac.uk)

Dr. Kate Court RSE Team
Newcastle University
(kate.court@newcastle.ac.uk)

Mark Turner RSE Team
Newcastle University
(mark.turner@newcastle.ac.uk)

Built With

Vite
TailWind
GitHub Pages
Figma

Getting Started

Prerequisites

An LTS version of NodeJS is required, and it is recommended to use yarn over npm.

Installation

To install the dependencies run

yarn install

Running Locally

To run the application in dev mode, run:

yarn dev

Running Tests

How to run tests on your local system.

Deployment

Local

The application can be served using the built-in vite webs server.

yarn dev

Watch the console for the port number that is serving the content.

Production

The run the production code locally, first build the minified files.

yarn build

This creates a dist folder containing all the production files. This can be served locally with a simple web server or be uploaded somewhere to be made public. There are GitHub workflows included for deploying the application using GitHub pages.

Usage

Any links to production environment, video demos and screenshots.

Roadmap

• Initial Research
• Minimum viable product
• Alpha Release
• Feature-Complete Release

Contributing

Main Branch

Protected and can only be pushed to via pull requests. Should be considered stable and a representation of production code.

Dev Branch

Should be considered fragile, code should compile and run but features may be prone to errors.

Feature Branches

A branch per feature being worked on.

https://nvie.com/posts/a-successful-git-branching-model/

License

Citiation

Please cite the associated papers for this work if you use this code:

@article{xxx2021paper,
  title={Title},
  author={Author},
  journal={arXiv},
  year={2021}
}

Acknowledgements

This work was funded by a grant from the UK Research Councils, EPSRC grant ref. EP/L012345/1, “Example project title, please update”.