From fa71a0a683114676af884cba69a9d0851b0b8fef Mon Sep 17 00:00:00 2001 From: zaidmukaddam Date: Wed, 7 Aug 2024 19:07:39 +0530 Subject: [PATCH] chore: Add README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..6540c18 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# MiniPerplx + +![MiniPerplx](/app/opengraph-image.png) + +A minimalistic AI-powered search engine that helps you find information on the internet. + +### Deploy your own + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fzaidmukaddam%2Fminiperplx&env=OPENAI_API_KEY,ANTHROPIC_API_KEY,TAVILY_API_KEY&envDescription=API%20keys%20needed%20for%20application) + +To run the example locally you need to: + +1. Sign up for accounts with the AI providers you want to use. OpenAI and Anthropic are required, Tavily is required for the web search feature. +2. Obtain API keys for each provider. +3. Set the required environment variables as shown in the `.env.example` file, but in a new file called `.env.local`. +4. `pnpm install` to install the required dependencies. +5. `pnpm dev` to launch the development server. +