diff --git a/README.md b/README.md index ff1aeb1..cc05401 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ # Tennis-Video-Viewer -A web app focused on tennis match playback, allowing timestamps for points +A web app focused on tennis match playback integrating with point-level data, supporting filtering the match by point attributes. + +# Getting Started +1. Clone the repo +2. Run `npm install` to install dependencies +3. Run `npm run dev` to run the test server +4. Navigate to `localhost:3000` in your browser # Development Notes A firestore database was created. A web app was linked in Project Settings -> Apps -> Web App. The config object was copied into the firebaseInit file. -csvjson.com: turn CSVs into JSON - -```npm run dev``` to run the test server \ No newline at end of file +Before uploading a CSV, it must be converted to JSON. Use csvjson.com. \ No newline at end of file