hockey_predictions_backend

API only Rails application built to supply information from NHL API to front end via RESTful conventions using a Service-Oriented Architecture.
Exposes endpoints to facilitate design of a front end interface for a game that allows users to predict the outcome of hockey games, as well as events that occur during a game.
Explore the docs »

· Report Bug · Request Feature

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments

About The Project

hockey_predictions will be a game to allow real-time predictions of nhl hockey games.

Users sign in using their Google account, and then are able to make predictions about the outcome of a specific game.

After an NHL game is finished, the user will be awarded points and then be placed on the leaderboard.

Future iterations will include additional events to predict prior to the beginning of each period.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

ruby v 2.7.4 rails v 5.2.8

Installation

Clone the repo

git clone https://github.com/marchandmd/hockey_predictions_backend.git

Install packages
```
bundle
```

(back to top)

Usage

This application will be live. Stay tuned.

(back to top)

Roadmap

establish connection with NHL through a service, and expose the list of games for the current calendar day
test and add relationships between user (has many predictions) and predictions (belongs_to user)

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!