Загрузка myChat - загрузка исходного кода myChat

myChat

AI Исходный код

1.0.0

Скачать

myChat: клон ChatGPT

myChat — это проект с открытым исходным кодом, созданный по образцу ChatGPT. Он предоставляет удобный интерфейс для взаимодействия с LLM, подобными GPT, через API OpenAI. Этот проект никаким образом НЕ связан напрямую с OpenAI.

Предварительные условия

Node.js >= 14
Ключ API OpenAI
База данных MongoDB
Экземпляр Redis

Используемые технологии

Next.js — платформа на основе React для создания веб-приложений, отображаемых на стороне сервера и статически экспортируемых.
OpenAI LLM — большие языковые модели, разработанные OpenAI.
Tailwind CSS — многофункциональная CSS-инфраструктура для быстрого создания пользовательских пользовательских интерфейсов.
Axios — популярная библиотека для выполнения HTTP-запросов на JavaScript.
NextAuth.js — комплексное решение для аутентификации приложений Next.js.
MongoDB — популярная база данных NoSQL, используемая для хранения информации о пользователях.
Mongoose — библиотека моделирования объектных данных (ODM) для MongoDB и Node.js.
Redis — хранилище структур данных в памяти, используемое в качестве базы данных, кеша и брокера сообщений.
Crypto — встроенный модуль Node.js для обработки криптографических операций.

Настраивать

Настройка МонгоБД

Мы используем MongoDB для хранения пользовательской информации и данных сеанса. Вы можете настроить экземпляр MongoDB несколькими способами:

Загрузите и установите MongoDB прямо на свой локальный компьютер.
Используйте контейнер Docker для запуска MongoDB.
Используйте управляемую службу MongoDB, например MongoDB Atlas, которая предлагает уровень бесплатного пользования.

Если у вас есть работающий экземпляр MongoDB, вам нужно будет получить строку подключения. Если вы используете MongoDB Atlas, вы можете найти строку подключения в настройках подключения вашего кластера.

Добавьте строку подключения MongoDB в файл .env.local следующим образом:

Настройка Redis

Мы используем Redis для ограничения скорости в наших маршрутах API. Вы можете настроить экземпляр Redis несколькими способами, в том числе:

Загрузите и установите Redis непосредственно на свой локальный компьютер (не рекомендуется пользователям Windows).
Используйте контейнер Docker для запуска Redis.
Используйте управляемую службу Redis, например RedisLabs, которая предлагает уровень бесплатного пользования.

Если у вас есть работающий экземпляр Redis, вам потребуется получить строку подключения. Если вы используете RedisLabs, вы можете найти строку подключения на странице конфигурации вашей базы данных.

Установка

Клонируйте этот репозиторий:
```
 git clone https://github.com/your-username/myChat.git
```
или начните использовать функцию шаблонов GitHub.
Перейдите в каталог проекта:
```
 cd myChat
```
Установите зависимости:
```
 npm install
```

Создайте файл .env.local в корне проекта и добавьте необходимые переменные среды:

 touch .env.local

Добавьте в файл .env.local следующее:

 NEXTAUTH_URL=http://localhost:3000
MONGODB_URI=yourURI
NEXTAUTH_SECRET=yourSecret
ENCRYPTION_KEY: a 32-digit hexadecimal string for AES-128 encryption (for users' API key)
REDIS_URL=yourRedisConnectionString

Замените http://localhost:3000 на любой порт, на котором работает ваше приложение, yourURI на строку подключения MongoDB, yourSecret на безопасную случайную строку, your32HexDigitString на 32-значную шестнадцатеричную строку для шифрования AES-128 и yourRedisConnectionString на ваш Redis. строка подключения.

...

Использование

Чтобы запустить сервер разработки:
```
 npm run dev
```
Чтобы создать приложение для производства:
```
 npm run build
```
Чтобы запустить рабочий сервер:
```
 npm run start
```

Развертывание

Чтобы развернуть клон myChat в Vercel, выполните следующие действия:

Зарегистрируйте учетную запись Vercel, если вы еще этого не сделали.
Установите Vercel CLI:
```
 npm install -g vercel
```
Войдите в свою учетную запись Vercel из командной строки:
```
 vercel login
```
Перейдите в каталог вашего проекта:
```
 cd myChat
```
Запустите следующую команду, чтобы развернуть приложение:
```
 vercel --prod
```
В процессе развертывания Vercel CLI запросит у вас переменные среды. Укажите те же значения, которые вы использовали для своего файла .env.local :
```
 NEXTAUTH_URL: https://your-vercel-url.vercel.app
MONGODB_URI: yourURI
NEXTAUTH_SECRET: yourSecret
ENCRYPTION_KEY: a 32-digit hexadecimal string for AES-128 encryption (for users' API key)
REDIS_URL=yourRedisConnectionString
```

Замените http://localhost:3000 на любой порт, на котором работает ваше приложение, yourURI на строку подключения MongoDB, yourSecret на безопасную случайную строку, your32HexDigitString на 32-значную шестнадцатеричную строку для шифрования AES-128 и yourRedisConnectionString на ваш Redis. строка подключения.

После завершения развертывания Vercel предоставит вам действующий URL-адрес для доступа к вашему клону myChat.

Помните, что каждый раз, когда вы вносите изменения в свой клон myChat и хотите развернуть обновленную версию, вы можете просто запустить vercel --prod из каталога проекта.

Содействие

Мы приветствуем вклады! Чтобы внести свой вклад, выполните следующие действия:

Форкнуть этот репозиторий
Клонируйте свою вилку на локальный компьютер: git clone https://github.com/your-username/myChat.git
Создайте свою ветку функций: git checkout -b feature/my-new-feature или git checkout -b fix/my-new-fix
Зафиксируйте изменения: git commit -am 'Add some feature'
Нажмите на ветку: git push origin feature/my-new-feature
Отправьте запрос на вытягивание