myChat

myChat: un clon de ChatGPT

myChat es un proyecto de código abierto inspirado en ChatGPT. Proporciona una interfaz fácil de usar para interactuar con LLM tipo GPT a través de la API OpenAI. Este proyecto NO está afiliado directamente con OpenAI de ninguna manera.

Tabla de contenido

• Requisitos previos
• Tecnologías utilizadas
• Instalación
• Configuración
• Uso
• Despliegue
• Contribuyendo
• Licencia

Requisitos previos

• Nodo.js >= 14
• Una clave API de OpenAI
• Una base de datos MongoDB
• Una instancia de Redis

Tecnologías utilizadas

• Next.js: un marco basado en React para crear aplicaciones web renderizadas en el lado del servidor y exportadas estáticamente
• OpenAI LLM: grandes modelos de lenguaje desarrollados por OpenAI
• Tailwind CSS: un marco CSS de utilidad para crear rápidamente interfaces de usuario personalizadas
• Axios: una biblioteca popular para realizar solicitudes HTTP en JavaScript
• NextAuth.js: una solución de autenticación completa para aplicaciones Next.js
• MongoDB: una base de datos NoSQL popular que se utiliza para almacenar información del usuario.
• Mongoose: una biblioteca de modelado de datos de objetos (ODM) para MongoDB y Node.js
• Redis: un almacén de estructura de datos en memoria, utilizado como base de datos, caché y intermediario de mensajes.
• Crypto: un módulo integrado de Node.js para manejar operaciones criptográficas

Configuración

Configuración de MongoDB

Utilizamos MongoDB para almacenar información del usuario y datos de sesión. Puede configurar una instancia de MongoDB de varias maneras:

• Descargue e instale MongoDB directamente en su máquina local.
• Utilice un contenedor Docker para ejecutar MongoDB.
• Utilice un servicio MongoDB administrado, como MongoDB Atlas, que ofrece un nivel gratuito.

Una vez que tenga una instancia de MongoDB en ejecución, necesitará obtener la cadena de conexión. Si está utilizando MongoDB Atlas, puede encontrar la cadena de conexión en la configuración de conexión de su clúster.

Agregue la cadena de conexión MongoDB a su archivo .env.local de esta manera:

Configuración de Redis

Usamos Redis para limitar la velocidad en nuestras rutas API. Puedes configurar una instancia de Redis de varias maneras, incluyendo:

• Descargue e instale Redis directamente en su máquina local (no recomendado para usuarios de Windows).
• Utilice un contenedor Docker para ejecutar Redis.
• Utilice un servicio Redis administrado, como RedisLabs, que ofrece un nivel gratuito.

Una vez que tenga una instancia de Redis en ejecución, necesitará obtener la cadena de conexión. Si está utilizando RedisLabs, puede encontrar la cadena de conexión en la página de configuración de su base de datos.

Instalación

1. Clona este repositorio:

    git clone https://github.com/your-username/myChat.git
   

   o comience a usar la función de plantilla de GitHub

2. Navegue al directorio del proyecto:

    cd myChat
   

3. Instale las dependencias:

    npm install
   

4. Cree un archivo .env.local en la raíz del proyecto y agregue las variables de entorno necesarias:

    touch .env.local
   

   Agregue lo siguiente al archivo .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
   

Reemplace http://localhost:3000 con cualquier puerto en el que se esté ejecutando su aplicación, yourURI con su cadena de conexión MongoDB, yourSecret con una cadena aleatoria segura, your32HexDigitString con una cadena hexadecimal de 32 dígitos para cifrado AES-128 y yourRedisConnectionString con su Redis cadena de conexión.

...

Uso

• Para ejecutar el servidor de desarrollo:

   npm run dev
  

• Para construir la aplicación para producción:

   npm run build
  

• Para iniciar el servidor de producción:

   npm run start
  

Despliegue

Para implementar su myChat Clone en Vercel, siga estos pasos:

1. Regístrese para obtener una cuenta Vercel si aún no lo ha hecho.

2. Instale la CLI de Vercel:

    npm install -g vercel
   

3. Inicie sesión en su cuenta Vercel desde la línea de comando:

    vercel login
   

4. Navegue hasta el directorio de su proyecto:

    cd myChat
   

5. Ejecute el siguiente comando para implementar su aplicación:

    vercel --prod
   

6. Durante el proceso de implementación, la CLI de Vercel le solicitará las variables de entorno. Proporcione los mismos valores que utilizó para su archivo .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
   

Reemplace http://localhost:3000 con cualquier puerto en el que se esté ejecutando su aplicación, yourURI con su cadena de conexión MongoDB, yourSecret con una cadena aleatoria segura, your32HexDigitString con una cadena hexadecimal de 32 dígitos para cifrado AES-128 y yourRedisConnectionString con su Redis cadena de conexión.

7. Una vez que se complete la implementación, Vercel le proporcionará una URL activa para acceder a su clon de myChat.

Recuerde que cada vez que realice cambios en su myChat Clone y desee implementar la versión actualizada, simplemente puede ejecutar vercel --prod desde el directorio del proyecto.

Contribuyendo

¡Agradecemos las contribuciones! Para contribuir, siga estos pasos:

1. Bifurcar este repositorio
2. Clona tu bifurcación en tu máquina local: git clone https://github.com/your-username/myChat.git
3. Crea tu rama de funciones: git checkout -b feature/my-new-feature o git checkout -b fix/my-new-fix
4. Confirme sus cambios: git commit -am 'Add some feature'
5. Empujar a la rama: git push origin feature/my-new-feature
6. Enviar una solicitud de extracción

Licencia

Este proyecto está bajo la licencia MIT.