From 04be5af4de743ca99d4480a9576830416ec3415e Mon Sep 17 00:00:00 2001 From: franekmagiera Date: Tue, 16 Jan 2024 20:41:16 +0100 Subject: [PATCH] Add README --- README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..a334a39 --- /dev/null +++ b/README.md @@ -0,0 +1,56 @@ +# Just Tell Me! + + + Made with Fresh + + +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)