ogd-website

The public website for Open Game Data

https://github.com/opengamedata/ogd-website

Science Score: 52.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
    Organization opengamedata has institutional domain (opengamedata.fielddaylab.wisc.edu)
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (13.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

The public website for Open Game Data

Basic Info
Statistics
  • Stars: 1
  • Watchers: 3
  • Forks: 0
  • Open Issues: 21
  • Releases: 1
Created over 5 years ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

opengamedata-website

Website front-end to the OpenGameData archive.

Building and Running for Local Debugging

Dev Requirements

  • Node - newer version; setup with LTS 18.14.1
  • cURL
  • Apache Server running localhost:8881 with vhosts pointing to %project_dir%/site
    • PHP - version 8.1
    • php_curl bindings

NOTE: a local install of PHP and the php_curl bindings are sufficient to test the site, though a full local Apache Server will provide the best emulation of the deploy environment.

Build the Website

  1. Create a copy of AppConfig.php from the AppConfig.php.template file in the %project_dir%/site/config folder.
    NOTE: This approach ensures local config settings are not committed by mistake. Any desired changes to the default configuration can be copied back to the .template file and committed.
  2. Run npm install in your %project_dir%
  3. Run gulp build to build the site for deployment.
    NOTE: Transpiled css and vendor js files are excluded from GIT

Run the dev API backend

The API (opengamedata-website-api) should be running on http://localhost:5000 in order to get Game Usage and Data Pipeline/Templates files list.

Alternately, you may use an online instance of the File API.

  • Comment out the following in the site/config/AppConfig.php file:

    php // If hostname starts with localhost if(!empty($_SERVER['HTTP_HOST']) && substr($_SERVER['HTTP_HOST'], 0, 9) === 'localhost') { // Assume we're in a development environment $APP_CONFIG['WEBSITE_API_URL_BASE'] = 'http://localhost:5000/'; }

  • Then make sure to set the $APP_CONFIG['WEBSITE_API_URL_BASE'] line with a valid online path, such as the main instance hosted on ogd-services: https://ogd-services.fielddaylab.wisc.edu/wsgi-bin/opengamedata/apis/files/app.wsgi/

Run the Website

There are a few options for running the website locally:

  1. Run gulp proxy to start dev server, proxying http://localhost:8881
- scss, js, php files are watched and will reload on change with Browser sync.
- See gulpfile.js for other gulp functions if needed (i.e., clean, build).
  1. Run php -S 127.0.0.1:5000 to start PHP development server
- Files are not watched, but changes will be reflected upon manually reloading the page.
- Changes to scss are not automatically built to update the generated css files.
  1. Run local Apache Server
- TODO

Owner

  • Name: Open Game Data
  • Login: opengamedata
  • Kind: organization

Open Game Data is a project out of the UW - Madison Field Day Lab to make datasets of anonymous play data public for science.

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: opengamedata-website
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - name: Field Day Lab
    city: Madison
    country: US
    region: Wisconsin
    website: 'https://fielddaylab.wisc.edu/'
  - given-names: Luke
    family-names: Swanson
    email: lwswanson2@wisc.edu
    affiliation: Field Day Lab
    orcid: 'https://orcid.org/0000-0002-8455-7441'
  - given-names: David
    family-names: Gagnon
    email: djgagnon@wisc.edu
    affiliation: Field Day Lab
    orcid: 'https://orcid.org/0000-0001-5126-0476'
repository-code: 'https://github.com/opengamedata/opengamedata-website'
url: 'https://opengamedata.fielddaylab.wisc.edu/index.php'
license: MIT

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 4
  • Total pull requests: 51
  • Average time to close issues: 13 minutes
  • Average time to close pull requests: 4 days
  • Total issue authors: 1
  • Total pull request authors: 5
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.06
  • Merged pull requests: 48
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 3
  • Pull requests: 17
  • Average time to close issues: 13 minutes
  • Average time to close pull requests: 8 days
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 15
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • LswaN58 (4)
Pull Request Authors
  • LswaN58 (22)
  • msherry2 (14)
  • rwilkinson3 (10)
  • soechting (3)
  • mrdavidgagnon (2)
Top Labels
Issue Labels
investigate (1) automation (1)
Pull Request Labels
automation (6) documentation (1)

Dependencies

.github/actions/web_config/action.yml actions
.github/workflows/website_CI.yml actions
  • ./.github/actions/web_config * composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • burnett01/rsync-deployments 5.2 composite
.github/workflows/website_release.yml actions
  • ./.github/actions/web_config * composite
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • burnett01/rsync-deployments 5.2 composite
package-lock.json npm
  • 449 dependencies
package.json npm
  • browser-sync ^2.28.3 development
  • gulp ^4.0.2 development
  • gulp-sass ^5.1.0 development
  • sass ^1.58.3 development
  • @popperjs/core ^2.11.6
  • axios ^1.3.4
  • bootstrap ^5.2.3
  • chart.js ^4.2.1
.github/workflows/website_branch_del_clean.yml actions
  • actions/upload-artifact v2 composite