From 16d5fb21dbfc0b7677715575e986d15a27d220a4 Mon Sep 17 00:00:00 2001 From: babaohuang Date: Sat, 16 Dec 2023 17:09:56 +0800 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++++++++++++------ 1 file changed, 32 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4447b13a..92f10e8a 100644 --- a/README.md +++ b/README.md @@ -12,14 +12,40 @@ This project is inspired by and based on the following open-source project: - [ChatGPT-Demo](https://github.com/anse-app/chatgpt-demo) - For the foundational codebase and features. -I extend my heartfelt gratitude to the original creators and contributors of these projects. Their work laid the groundwork for the development of GeminiProChat. -## Licensing +## Running Locally -This project is released under the MIT License, in accordance with the licensing terms of the original projects mentioned above. +### Pre environment +1. **Node**: Check that both your development environment and deployment environment are using `Node v18` or later. You can use [nvm](https://github.com/nvm-sh/nvm) to manage multiple `node` versions locally. + ```bash + node -v + ``` +2. **PNPM**: We recommend using [pnpm](https://pnpm.io/) to manage dependencies. If you have never installed pnpm, you can install it with the following command: + ```bash + npm i -g pnpm + ``` +3. **GEMINI_API_KEY**: Before running this application, you need to obtain the API key from Google. You can register the API key at [https://makersuite.google.com/app/apikey](https://makersuite.google.com/app/apikey). -## Installation and Setup +### Getting Started -Detailed instructions on how to install and set up GeminiProChat will be provided soon. I am currently working on refining the installation guide to ensure it is clear and helpful for all users. +1. Install dependencies + ```bash + pnpm install + ``` +2. Copy the `.env.example` file, then rename it to `.env`, and add your [GEMINI API key](https://makersuite.google.com/app/apikey) to the `.env` file. + ```bash + GEMINI_API_KEY=AIzaSy... + ``` +3. Run the application, the local project runs on `http://localhost:3000/` + ```bash + pnpm run dev + ``` + +## Deploy + +### Deploy With Vercel + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/babaohuang/GeminiProChat&env=GEMINI_API_KEY) + +Just click the button above and follow the instructions to deploy your own copy of the app. -Please stay tuned for updates to the README, which will include step-by-step installation and configuration instructions, along with additional information about the features and capabilities of GeminiProChat. \ No newline at end of file