Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
taylorhughes authored Jan 31, 2023
1 parent 20d5305 commit 5918167
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ This app is a proof of concept and comes with no warranty or guarantees. Enjoy!

The app is an Electron app, which means it's a Node.js web app that runs in a version of Chromium on your local computer. The app uses [remix-electron](https://github.com/itsMapleLeaf/remix-electron) for its basic structure, with React and Tailwind for the very lovely frontend you can see.

To get the data from Slack, the app uses [puppeteer-in-electron](https://www.npmjs.com/package/puppeteer-in-electron) (pie) to instrument slack.com. Once you log in and establish a session, puppeteer waits for the Slack web client to load in a headless window, and issues some additional API requests to make sure message content is loaded. The app listens to Slack's internal API call results, and then gathers unread content (channels, threads and DMs) for display & summarization.
To get the data from Slack, the app uses [puppeteer-in-electron](https://www.npmjs.com/package/puppeteer-in-electron) (pie) to instrument slack.com. Once you log in and establish a session (See: [routes/login/$slug.tsx](https://github.com/taylorhughes/unread-electron/blob/main/app/routes/login/%24slug.tsx#L80), [storeCredentials](https://github.com/taylorhughes/unread-electron/blob/main/app/unread/slack/index.server.ts#L80)), puppeteer waits for the Slack web client to load in a headless window (See: [SlackUnreadsLoader](https://github.com/taylorhughes/unread-electron/blob/main/app/unread/slack/SlackUnreadsLoader.server.ts#L431)), and issues some additional API requests to make sure message content is loaded. The app listens to Slack's internal API call results (See: [SlackPageDataModel](https://github.com/taylorhughes/unread-electron/blob/main/app/unread/slack/SlackPageDataModel.server.ts#L219)), and then gathers unread content (channels, threads and DMs) for display & summarization.

Summarizing is the easy part: We take the Slack messages pulled from the previous step and add a prompt to GPT-3, then OpenAI gives us back the summary. We do our best to maintain usernames for display in this step. Welcome to the future.
Summarizing is the easy part: We take the Slack messages pulled from the previous step and add a prompt to GPT-3, then OpenAI gives us back the summary. We [do our best](https://github.com/taylorhughes/unread-electron/blob/main/app/unread/slack/SlackUnreadsLoader.server.ts#L92) to maintain usernames for display in this step. Welcome to the future.

## Running Locally

Expand Down

0 comments on commit 5918167

Please sign in to comment.