diff --git a/readme.md b/readme.md index cfa5b2b..a1c8c56 100644 --- a/readme.md +++ b/readme.md @@ -2,11 +2,11 @@ > Surf crowd predictions -As a [surfer](https://en.m.wikipedia.org/wiki/Surfing) you are constantly trying to assess the best time to surf. This not only involves looking at the forecast and conditions but also gauging when it's going to be most crowded. Sometimes you'll get more waves if you surf when the conditions are a little worse but the spot is less crowded - an exercise in game theory. +As a [surfer](https://en.m.wikipedia.org/wiki/Surfing) you are constantly trying to assess the best time to surf. This not only involves looking at the forecast and conditions but also gauging when it's going to be most crowded. Sometimes you'll get more waves if you surf when the conditions are a little worse but the spot is less crowded - an exercise in game theory. In order to make the best decision on when to surf you need forecast data on both the waves conditions and the crowd. The former is easy to get from [surfline](https://www.surfline.com/) but there is no data on surf crowds... YET! -The idea is that Crowdfactor provides an interface similar to google maps *["popular times"](https://blog.google/products/maps/maps101-popular-times-and-live-busyness-information/)*, giving a more quantitative approach on deciding when to surf. +The idea is that Crowdfactor provides an interface similar to google maps _["popular times"](https://blog.google/products/maps/maps101-popular-times-and-live-busyness-information/)_, giving a more quantitative approach on deciding when to surf. ![Google popular times](img/populartimes.png) @@ -24,7 +24,7 @@ These predictions are visualised along side the real recordings and the forecast ## Usage: -First find your spot on [surfline](https://www.surfline.com), copy the spot_id from the URL. Then create a [roboflow account](https://roboflow.com/) and get an API key. +First find your spot on [surfline](https://www.surfline.com), copy the spot_id from the URL. Then create a [roboflow account](https://roboflow.com/) and get an API key. Then run it the project with docker-compose: @@ -55,3 +55,19 @@ SURFLINE_SPOT_ID=590927576a2e4300134fbed8 ROBOFLOW_API_KEY= FLASK_DEBUG= ``` SURFLINE_SPOT_ID=590927576a2e4300134fbed8 ROBOFLOW_API_KEY= FLASK_DEBUG=1 FLASK_APP=lib/app flask run ``` + +## Deploying on fly. + +Adjust the `app` name in fly.toml if needed. + +You'll need to create a volume called `crowdfactor_data` + +``` +fly volume create crowdfactor_data --config ./fly.toml +``` + +Then deploy: + +``` +fly deploy +```