Giter VIP home page Giter VIP logo

cryptogolf's Introduction

crytoGolf

A game of golf, with a few twists.
Play the demo! https://guarded-fortress-57011.herokuapp.com/


How to Play

To start, the user will select their favorite cryptocurrency.
This will perform an API call to generate the ground on which the game is played;
it might help to pray for a stable day in the crypto markets!
Then, a ball will generate for the user to hit.
From here, just aim for the hole, and swing away!

How to Install & Run

To install,

  • clone the repo
  • run npm install

To run,

Project Description

This is my personal fork of a group project.
It was demoed to a group of other programmers along with a Powerpoint Presentation;
I created it, ran the demo, and am quite pleased with how it turned out, all things considered.

The PPs are available for viewing here: https://docs.google.com/presentation/d/13ZuqBCF-6kWDh_LJ6N-ZTZI-vsIbP5VXtHiNx92Tfo4/edit?usp=sharing
For reference, Jared and Cris are two more experienced programmers who provided feedback.
All images used in the slides are assumed fair use/non-commercial purposes;
if alerted that any are not, they will be removed.

The original project README can be found directly below.

Project Description

This project represents a group effort to create a physics-based golf game, with a twist:
the terrain is generated based on the ups and downs of the cryptocurrency market.

The project was conceived and organized by Chandler Dibble;
it was developed by a four-person team over one week.
The total time spent developing our project, including time spent learning new tools, is estimated at 120+ hours.

We primarily utilized Javascript with Node, JQuery, Matter.js, and Express.js.
HTML and CSS were deliberately de-emphasized to allow us to generate our images, shapes, etc. with Javascript.
This is reflected in contributors' roles all including "back-end" work.
Bitfinex's API was utilized to provide our cryptocurrency exchange data, with which we generated our terrain.
Heroku was also utilized for the first time by group members, as previous projects were hosted solely on Github Pages.
Significant time was devoted to learning Matter.js.

Internally, we needed to generate a basic world and physics-based parameters for our game.
Objects such as a golf ball were created and assigned values to allow their proper interaction.
Functions were written to generate our objects, cause them to interact, and influence the manner in which they interacted.
The Bitfinex API was called in order to generate the ground on which golf was played.
Each project member spent time learning how to implement Matter.js.
Expertise on cryptocurrencies was provided by Tim Hill.

Contributors

Afolabi Akingbe - troubleshooting/math MVP; research, back-end;
Github: https://github.com/folaakingbe
Chandler Dibble- project lead/organizer; research, back-end/front-end;
Github: https://github.com/Xhandler
Tim Hill - cryptocurrency expert; research, initial organiziation, back-end;
Github: https://github.com/peakcodes
Daniel Mace - project historian/note-taker; research, back-end/front-end, PPs, Heroku;
Github: https://github.com/Daniibooii

Notes

Our initial project idea was gito create a Rube Goldberg game;
it became apparent that this wouldn't be viable within the timeframe we allotted ourselves.

To view our original work, please see: https://github.com/Xhandler/rubegoldberg
Future work on rubegoldberg, collaborative or independent, is possible.

Inspirations

Desert Golfing served as our initial inspiration;
the idea of combining this with cryptocurrency was provided by Jared Nielsen.

Resources

Project Group's One Drive: https://onedrive.live.com/view.aspx?resid=A24E366977AFCFDC!951&app=OneNote&authkey=!ALdVeX0u2AWWcC0
Matter.js Package: https://www.npmjs.com/package/matter-js
Matter.js Info/Tutorials: http://brm.io/matter-js/
Express.js Package: https://www.npmjs.com/package/express
Express.js Info/Tutorials: https://expressjs.com/
Heroku Deployment Guide: https://github.com/nielsenjared/node-express-heroku-deployment

Desert Golf: http://desertgolfing.captain-games.com/
Many Golf Main Site: https://manygolf.club/
Many Golf Repo: https://github.com/thomasboyt/manygolf
Bitfinex Main Site: https://www.bitfinex.com/

cryptogolf's People

Contributors

daniibooii avatar peakcodes avatar folaakingbe avatar

Stargazers

 avatar

Watchers

James Cloos avatar

Forkers

toddbernhard

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.