Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

SourceShelf

SourceShelf is a collaborative research workspace built with React and DeepSpace. Create a topic, save search results or your own links with excerpts, add notes, and generate a short summary with clickable citations.

Run locally

If your DeepSpace account has source access, clone with npx deepspace clone source-shelf.

Use a Node version supported by package.json and a DeepSpace developer account.

npm ci
npx deepspace auth whoami
npm run dev

Open the local address printed by the CLI and sign in to the app. The CLI session manages the deployment. The separate browser session identifies the person using the workspace. This checkout targets an existing DeepSpace app. To deploy an independent copy, choose a unique Wrangler name and initialize a separate app identity with npx deepspace app init --new-id.

Demo the workflow

  1. Create a topic and search Wikipedia. Save a result, or add a source manually with a public link and a relevant excerpt.
  2. Select one or more saved sources and generate an excerpt summary. Each item links to the stored source URL.
  3. Ask a collaborator to sign in and send you the value under Your sharing ID. Open Manage access to add that person as an editor. Share the topic URL so they can open it directly. Editors can add sources, notes, and summaries. The owner can remove access.

Read the code

Area Where to look
Workspace and forms src/pages/(app)/(protected)/home.tsx
Records and access policies src/schemas/research-schema.ts
Validation, membership, and writes src/actions/index.ts
Direct Wikipedia request, result validation, and excerpt formatting src/actions/wikipedia.ts, src/lib/wikipedia.ts, src/lib/research.ts
Proxy search and authenticated requests src/lib/research-client.ts
Citation shape and excerpt summaries src/lib/research.ts

DeepSpace stores topics, membership rows, and research entries in its RecordRoom. A topic ID doubles as the SDK team ID. The RecordRoom filters reads for every role, and useQuery subscribes to those filtered results. The actions check membership before using privileged record tools. Each contribution is a separate row and is stored under the topic owner, so a removed editor loses the SDK's implicit creator access to their contributions too.

The excerpt summary selects up to six saved excerpts and uses the first sentence or a short clipped passage from each. The AI option sends only selected excerpts. It accepts structured claims linked to source numbers, then builds citation URLs from saved records. The model can still misinterpret evidence. Check each claim against its citation.

Integration Purpose Billing
Wikipedia REST search Default reference search and proxy fallback Public Wikimedia endpoint, no DeepSpace integration credits
Wikipedia via DeepSpace Optional reference search through wikipedia/search-pages Caller pays $0.0013 per request at the catalog rate
Exa via DeepSpace Broader web search with supporting text Optional, caller pays
OpenAI via DeepSpace Paraphrased synthesis of selected excerpts Optional, caller pays

Checks and deploy

npm run validate
npm run lint
npm run build
npx deepspace test run all
npx deepspace deploy

The collaboration checks use three accounts in the DeepSpace test account pool. Create them with npx deepspace test accounts create --help and pass the generated passwords over stdin. The workflow test hits live Wikipedia. The Exa error and empty-state test and the Wikipedia proxy test stub paid responses and spend no credits. The Wikipedia test also exercises the live direct fallback.

Commit before deploying. The first release syncs the commit to the DeepSpace cloud repository through the space remote. See SUBMISSION.md for the exercise writeup.

Updating the GitHub reviewer copy

The DeepSpace deploy syncs the DeepSpace Git repository. Update the GitHub reviewer repository separately. In GitHub, open the repository root and choose Add file → Upload files, then drag in the changed files and folders with the same repository-relative paths. Review the changed paths before committing, including the paired package.json and package-lock.json changes when dependencies change. To edit a single existing file, open it and use the pencil icon. The GitHub web commit does not trigger a DeepSpace release.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages