Skip to content

Commit ca6c223

Browse files
committed
update README with required fields
1 parent 93b1d53 commit ca6c223

4 files changed

Lines changed: 11553 additions & 2 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,28 @@ React + TypeScript + Vite + SWC (with Rust compiler)
1111
3. You will need a local .env file with secret variables. Reach out to Ethan for these.
1212
4. Run ```bun run dev``` to start the development server.
1313

14+
## File Format Requirements
15+
16+
The application accepts the following file formats:
17+
- CSV (Comma Separated Values)
18+
- TSV (Tab Separated Values)
19+
- JSON
20+
21+
### Required Fields
22+
Your data file must include the following fields:
23+
- `Time`: Can be either a string or number
24+
- `Step Name`: String
25+
- `Outcome`: String
26+
- `CF (Workspace Progress Status)`: String
27+
- `Problem Name`: String
28+
- `Anon Student Id`: String
29+
30+
### Example Format
31+
```csv
32+
Time,Step Name,Outcome,CF (Workspace Progress Status),Problem Name,Anon Student Id
33+
2024-01-01 10:00:00,Step 1,OK,GRADUATED,Problem 1,student123
34+
2024-01-01 10:01:00,Step 2,ERROR,NOT_COMPLETED,Problem 1,student123
35+
```
1436

1537
## Expanding the ESLint configuration
1638

0 commit comments

Comments
 (0)