Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
babaohuang committed Dec 16, 2023
1 parent 7244c92 commit 16d5fb2
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

1 comment on commit 16d5fb2

@vercel
Copy link

@vercel vercel bot commented on 16d5fb2 Dec 16, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.