NFL Fantasy Football Trade Anaylzer

You can find the deployed project at http://www.tacklemytrade.com/

Contributors

Thatcher Phan	Laura Theimer	Joshua Doan	Tiffany Simionescu

[](netlify link goes in these parenthesis)

Project Overview

[Trello Board] https://trello.com/b/GR22EAEc/nfl-fantasy-perfect-trade

[Product Canvas] https://www.notion.so/NFL-Fantasy-Perfect-Trade-881bd44def114fda8cffd8ccc362caf0

[UX Design files] https://drive.google.com/drive/folders/1ITqPq3QO9YYWnI4oXH267EZuELNh-yTQ

Tackle My Trade NFL Fantasy Football Trade Anaylzer is to help a fan to build their ultimate fantasy league, by making the optinmal trades trades to win their fantasy competions. The application is user friendly for new fans that want to enjoy another excitment but not just watching the game, but having their own team to score points to win the bragging rights for each season. It's also packed full, (not current release) of predictions and more stats for more advanced fans.

4️⃣ Key Features

Fan can pick two NFL football players to anaylzer to see who would score more points per week.
Fan can pick 17 different weeks to see if a player is better than other player.
Fan can register/login to have a personal dashboard.

1️⃣ Tech Stack

Front end built using:

React
Material-ui
LESS CSS
Styled-Components
Redux
Heroku
React-Router-Dom

Front end deployed to Heroku

Back end built using:

Postgres
Heroku
Express
Cors
Knex
Nodemon
Jsonwebtoken

APIs

2️⃣ Authentication API https://tacklemytrade-api.herokuapp.com/api/

Base api url for the backend.

3️⃣ Data Science API https://nfl-trade.herokuapp.com - under the Methodology Tab

The datascience api that hooks to the backend. This is where all 621 players stats are.

5️⃣ Content Licenses

🚫For all content - images, icons, etc, use this table to document permission of use. Remove the two placeholders and add you content to this table

Image Filename	Source / Creator	License
Icomoon	https://icomoon.io/#home
Images	https://unsplash.com/
Dashboard Pic	SporLab	https://unsplash.com/photos/-cFN2l2Q-zY

4️⃣ Testing

🚫Document what you used for testing and why

4️⃣ Installation Instructions

NPM install

Other Scripts

"start": "react-scripts start", "build": "react-scripts build", "test": "react-scripts test", "eject": "react-scripts eject"

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

Check first to see if your issue has already been reported.
Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
Create a live example of the problem.
Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

Ensure any install or build dependencies are removed before the end of the layer when doing a build.
Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
Ensure that your code conforms to our existing code conventions and test coverage.
Include the relevant issue number, if applicable.
You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.