Specs document

Jump to bottom

UMjp edited this page May 12, 2023 · 2 revisions

Step 1, MVP: One person, performing a set of tasks, all from same basic interface

Create/improve query
See query results
Background: run query
Label some of the results
Rinse and repeat
Create front-end specs doc (see related Wiki page)

Step 2: Add backend

Later, we will add a backend that does the querying. At that point, the front end will switch from directly communicating with the reddit API to communicating with the server. We will implement the server using Django or nextJS, deployed using heroku via Github.
Specification of backend endpoints and how to contact them
- Run_query
- Save_query
- Save_label
- Get_labels (for a set of comments)
  - Or maybe that comes with the query results
Specify how front end asks back end to execute query and format of results that come back
Create a mocked backend to enable front end development

Step 3: Add classifier

Background: retrain classifier after new labels come in
Run classifier on query results and make them available in the interface

Step 4: Divide tasks into multiple roles