Skip to content

Commit

Permalink
Added Getting Started to README
Browse files Browse the repository at this point in the history
  • Loading branch information
awest25 committed Dec 11, 2023
1 parent a8bb256 commit 4fc4c83
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Before uploading a CSV, it must be converted to JSON. Use csvjson.com.

0 comments on commit 4fc4c83

Please sign in to comment.