Tag
ChatGPT
Type
Code
Created
Mar 30, 2023 03:30 AM

ChatGPT-API Demo

English | 简体中文
A demo repo based on OpenAI GPT-3.5 Turbo API.
notion image
Live preview
:
notion image

Running Locally

Pre environment

  1. Node: Check that both your development environment and deployment environment are using Node v18 or later. You can use nvm to manage multiple node versions locally。
    1. PNPM: We recommend using pnpm to manage dependencies. If you have never installed pnpm, you can install it with the following command:
      1. OPENAI_API_KEY: Before running this application, you need to obtain the API key from OpenAI. You can register the API key at https://beta.openai.com/signup.

      Getting Started

      1. Install dependencies
        1. Copy the .env.example file, then rename it to .env, and add your OpenAI API key to the .env file.
          1. Run the application, the local project runs on http://localhost:3000/

            Deploy

            Deploy With Vercel

            notion image
            notion image

            Deploy With Netlify

            notion image
            Step-by-step deployment tutorial:
            1. Fork this project,Go to https://app.netlify.com/start new Site, select the project you forked done, and connect it with your GitHub account.
            notion image
            notion image
            1. Select the branch you want to deploy, then configure environment variables in the project settings.
            notion image
            1. Select the default build command and output directory, Click the Deploy Site button to start deploying the site。
            notion image

            Deploy with Docker

            Before deploying the app, please make sure .env is configured normally.

            Deploy on more servers

            Please refer to the official deployment documentation:https://docs.astro.build/en/guides/deploy

            Environment Variables

            You can control the website through environment variables.
            Name
            Description
            Default
            OPENAI_API_KEY
            Your API Key for OpenAI.
            null
            HTTPS_PROXY
            Provide proxy for OpenAI API. e.g. http://127.0.0.1:7890
            null
            OPENAI_API_BASE_URL
            Custom base url for OpenAI API.
            https://api.openai.com
            HEAD_SCRIPTS
            Inject analytics or other scripts before </head> of the page
            null
            SECRET_KEY
            Secret string for the project. Use for generating signatures for API calls
            null
            SITE_PASSWORD
            Set password for site. If not set, site will be public
            null
            OPENAI_API_MODEL
            ID of the model to use. List models
            gpt-3.5-turbo

            Frequently Asked Questions

            Q: TypeError: fetch failed (can't connect to OpenAI Api)
            A: Configure environment variables HTTPS_PROXY,reference: #34
            Q: throw new TypeError(${context} is not a ReadableStream.)
            A: The Node version needs to be v18 or later,reference: #65
            Q: Accelerate domestic access without the need for proxy deployment tutorial?
            A: You can refer to this tutorial: #270
            Q: PWA is not working?
            A: Current PWA does not support deployment on Netlify, you can choose vercel or node deployment.

            Contributing

            This project exists thanks to all those who contributed.
            Thank you to all our supporters!
            notion image
            notion image

            License

            MIT © ddiu8081
            • Twikoo
            公告
            🎉欢迎光临🎉
            -- 感谢您的支持 ---