浏览代码

Updating readme and removing a TODO

Kirk Trombley 5 年之前
父节点
当前提交
56411d6e48
共有 2 个文件被更改,包括 19 次插入25 次删除
  1. 19 24
      README.md
  2. 0 1
      ui/src/components/round-summary.component.jsx

+ 19 - 24
README.md

@@ -6,9 +6,7 @@
 ./docker/build.sh
 ```
 
-## Back End
-
-In the future, names should be tracked via actual tokens
+## API
 
 ```
 API Endpoints
@@ -84,25 +82,22 @@ POST /game/{ID}/guesses/{round}
     }
 ```
 
-## Front End
+## Next Steps
 
-```
-- Render streetview pano
-- Render map for guessing
-    - On click, place and track marker for guess
-- Render control pane
-    - Submit button
-    - Timer
-    - Round counter
-    - Current scores
-- Fetch /game/{ID}, extract coords and timer length
-- Main Loop
-    - Fetch /game/{ID}/guesses/{name}, update scores and round
-        - if round comes back null, redirect to /summary/{ID}
-    - Extract current coord
-    - Clear map markers
-    - Zoom out map
-    - Change pano to coord
-    - Reset timer
-    - On timeout or submit -> POST to /game/{ID}/guesses/{name}/{round}
-```
+- Refactor round tracking in database logic
+- Reduce complexity of `game_api` in back-end
+- Reduce complexity of `GamePanel` in front-end
+- Genericize number of rounds
+- Genericize round timer in UI
+- Finalize scoring formula
+- Button to return the street view pano to the target
+- Track name via tokens
+- Error handling in UI
+- Live update summary page
+- Navigate directly to summary page
+- Navigate directly to joining a game
+- Re-join a game you did not finish
+- Show current best on round summary
+- Round summary should use dynamic map
+- Cache API key after first call to back-end
+- Styling and layout improvements

+ 0 - 1
ui/src/components/round-summary.component.jsx

@@ -2,7 +2,6 @@ import React from "react";
 import withGoogleApiKey from "./with-google-key.component";
 
 // TODO eventually we want this to query and show other players
-// TODO also should show the actual location of the last round
 
 const RoundSummary = ({ googleApiKey, round, onNext }) => {
   const {