Skip to content

Commit 15a1f14

Browse files
committed
chore(readme): update the readme
1 parent fa994e4 commit 15a1f14

1 file changed

Lines changed: 32 additions & 14 deletions

File tree

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,54 @@
11
# Draft Aid (Fantasy Football)
22

3-
## draftaid-react
4-
5-
This repository contains a modified version of Jay Zheng's draftaid-react project, which can be found at: [https://github.com/jayjzheng/draftaid-react](https://github.com/jayjzheng/draftaid-react)
3+
Give it a try today at: https://aptmac.github.io/draftaid-react/
64

7-
## Installation and usage
8-
I have included a script that can be used for easy local deployment. In the top level of this project, use the command `./run.sh` from the terminal to have the project install, build, and run all at once. When built, the application will be served at [http://localhost:3000](http://localhost:3000).
5+
![example-gif](https://user-images.githubusercontent.com/10425301/187034174-7bbb7781-e170-4c6d-92bd-d89fe3729c1a.gif)
96

10-
If you are interested in external web hosting, please see Jay Zheng's original repos for more details. This is a react-based project, so the commands required to run this application are:
7+
## draftaid-react
118

12-
- Install: `npm install`
13-
- Build: `npm run build`
14-
- Run: `npm start`
9+
This repository contains a modified version of Jay Zheng's draftaid-react project, which can be found at: [https://github.com/jayjzheng/draftaid-react](https://github.com/jayjzheng/draftaid-react)
1510

16-
Note that you will need to have npm installed and configured on your machine.
11+
This application was re-arranged and bootstrapped using the Patternfly seed project: https://github.com/patternfly/patternfly-react-seed
1712

1813
## Using BeerSheets
1914

2015
Check them out at: http://footballabsurdity.com/beersheet-request-form/
2116

22-
I've included a script `fetch_beersheets.py` that will make a request and fetch a csv file from them. Note that if you're using an obscure Fantasy Football settings format that you may need to request your sheet in advance so it's available by the time the script is run.
17+
This repository is now powered by Beersheets instead of the former Boris Chen and fantasypros versions. I'm not affiliated with Beersheets in any way, just a big fan.
2318

24-
You can customize the configuration values directly in a `fetch_beersheets.py`, at the top of the script I've made a big ol' dictionary so it should be just a matter of updating the values to suit your needs. The default at the moment is a generic 12-team half-ppr setting. To use, select the "BeerSheets" option from the dropdown in the application ui.
19+
The idea here is that you can get your own Beersheet CSV file customized to your own league settings, and then drag it into the draftaid UI to get a customized draft board.
2520

26-
If you'd rather supply your own beersheet, you can pass it as an argument to the python script (e.g., `python fetch_beersheets.py <path-to-csv>`) and the script will convert it to the proper format for draftaid.
21+
The position tables will be populated by the Beersheets tier information, but the overall undrafted players list will be populated by Expert Concensus Rankings (ECR). This will create instances where a player may be rated higher or lower depending on what table you're looking at, but the idea is that the position tables will tell you the best player avaiable for each position, and the ECR should (hopefully) give you an indication of who is being drafted at your current spot in the draft.
2722

2823
## Differences from the original application
2924

3025
Jay Zheng's original application is great out of the box. However, I wanted to tweak a few things before using it for my own fantasy draft purposes.
3126

3227
- This project uses Beersheets rankings instead of Boris Chen's rankings
33-
- Moved the master list of undrafted players to be inbetween the lists of players by position and drafted players
28+
- Moved and resized the tables to make it ideal for using in split screen mode
29+
- Updated the colour coding; each position has it's own colour and uses shades to indicate tiers
30+
- Drag-n-drop functionality! Bring your own customized Beersheet for use in draftaid
31+
32+
## Development scripts
33+
```sh
34+
# Install development/build dependencies
35+
npm install
36+
37+
# Start the development server
38+
npm run start:dev
39+
40+
# Run a production build (outputs to "dist" dir)
41+
npm run build
42+
43+
# Run the linter
44+
npm run lint
45+
46+
# Run the code formatter
47+
npm run format
48+
49+
# Start the express server (run a production build first)
50+
npm run start
51+
```
3452

3553
## Kudos
3654

0 commit comments

Comments
 (0)