Skip to content

Commit

Permalink
Add README
Browse files Browse the repository at this point in the history
  • Loading branch information
franekmagiera committed Jan 16, 2024
1 parent fea013f commit 04be5af
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Just Tell Me!

<a href="https://fresh.deno.dev">
<img
width="197"
height="37"
src="https://fresh.deno.dev/fresh-badge-dark.svg"
alt="Made with Fresh"
/>
</a>

Have you ever wasted some time watching a youtube video, that got you kind of
interested because of the click-baity topic, but in the end turned out to be
nothing more BUT click-bait? Or have you ever wanted to just quickly recall what
a video that you've watched some time ago was about? Just Tell Me has you
covered!

Just Tell Me is an app that summarizes youtube videos using ChatGPT. It uses the
captions provided by youtube to ask ChatGPT to summarize the content.

Check it out at https://just-tell-me.deno.dev/.

The core of the app is written in Typescript and relies on
[Deno](https://docs.deno.com/runtime/manual). The web app is built with
[Fresh](https://fresh.deno.dev/) and deployed with
[Deno Deploy](https://deno.com/deploy).

## How to run

You can run the app from the CLI if you have `deno` installed:

```
deno run -A run.ts youtubeVideoId
```

The program relies on OpenAI API for ChatGPT and requires a `OPENAI_API_KEY`
environment variable that contains a valid OpenAI API key.

By default, the app uses the `gpt-3.5-turbo-1106` model, but you can also use
`gpt-4` and `gpt-4-1106-preview`, by including a `--model=gpt-4` flag.

Optionally, you can run the app in test mode (only `test` is considered a valid
video id then) with:

```
TEST=true deno run -A run.ts test
```

To launch the web app locally, run:

```
deno task start
```

(You can also include `TEST=true` environment variable, to run the web app in
test mode)

0 comments on commit 04be5af

Please sign in to comment.