From 34de984fb8b7bc2b2b5b2b98132feef5ad9df561 Mon Sep 17 00:00:00 2001 From: "dayuan.jiang" Date: Mon, 10 Nov 2025 19:52:08 +0900 Subject: [PATCH] docs: update README and add env.example for API key configuration --- README.md | 13 +++++++------ env.example | 9 +++++++++ 2 files changed, 16 insertions(+), 6 deletions(-) create mode 100644 env.example diff --git a/README.md b/README.md index 0b9f93a..ee98136 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,8 @@ A next.js web application that integrates AI capabilities with draw.io diagrams. This app allows you to create, modify, and enhance diagrams through natural language commands and AI-assisted visualization. - https://github.com/user-attachments/assets/b2eef5f3-b335-4e71-a755-dc2e80931979 - Demo site: [https://next-ai-draw-io.vercel.app/](https://next-ai-draw-io.vercel.app/) ## Features @@ -47,12 +45,15 @@ npm install yarn install ``` -3. Create a `.env.local` file in the root directory with the following variables: +3. Create a `.env.local` file in the root directory. You can use `env.example` as a template: +```bash +cp env.example .env.local ``` -OPENAI_API_KEY=your_openai_api_key_here -# Add any other required environment variables -``` + +Then update `.env.local` with your actual API keys: + +Note: Not all variables are required. At minimum, you'll need at least one AI provider API key (OpenAI, Google, or OpenRouter). 4. Run the development server: diff --git a/env.example b/env.example new file mode 100644 index 0000000..e9a6bd3 --- /dev/null +++ b/env.example @@ -0,0 +1,9 @@ +# add the needed api + +GOOGLE_GENERATIVE_AI_API_KEY="your-google-api-key-here" +OPENAI_API_KEY="your-openai-api-key-here" +PERSONAL_ACCESS_TOKEN="your-github-personal-access-token-here" +AWS_ACCESS_KEY_ID=your-aws-access-key-id +AWS_SECRET_ACCESS_KEY=your-aws-secret-access-key +AWS_REGION=your-region +OPENROUTER_API_KEY="your-openrouter-api-key-here"