myChat

myChat: um clone do ChatGPT

myChat é um projeto de código aberto modelado a partir do ChatGPT. Ele fornece uma interface amigável para interagir com LLMs do tipo GPT por meio da API OpenAI. Este projeto NÃO é afiliado diretamente à OpenAI de forma alguma.

Índice

• Pré-requisitos
• Tecnologias Utilizadas
• Instalação
• Configurar
• Uso
• Implantação
• Contribuindo
• Licença

Pré-requisitos

• Node.js >= 14
• Uma chave de API OpenAI
• Um banco de dados MongoDB
• Uma instância do Redis

Tecnologias Utilizadas

• Next.js – Uma estrutura baseada em React para construir aplicativos da web renderizados no lado do servidor e exportados estaticamente
• OpenAI LLMs - Grandes modelos de linguagem desenvolvidos pela OpenAI
• Tailwind CSS – Uma estrutura CSS utilitária para construir rapidamente interfaces de usuário personalizadas
• Axios – Uma biblioteca popular para fazer solicitações HTTP em JavaScript
• NextAuth.js – Uma solução completa de autenticação para aplicativos Next.js
• MongoDB – Um banco de dados NoSQL popular usado para armazenar informações do usuário
• Mongoose - Uma biblioteca Object Data Modeling (ODM) para MongoDB e Node.js
• Redis - Um armazenamento de estrutura de dados na memória, usado como banco de dados, cache e corretor de mensagens
• Crypto – Um módulo Node.js integrado para lidar com operações criptográficas

Configurar

Configuração do MongoDB

Usamos MongoDB para armazenar informações do usuário e dados da sessão. Você pode configurar uma instância do MongoDB de várias maneiras:

• Baixe e instale o MongoDB diretamente em sua máquina local.
• Use um contêiner Docker para executar o MongoDB.
• Use um serviço gerenciado do MongoDB, como o MongoDB Atlas, que oferece um nível gratuito.

Depois de ter uma instância do MongoDB em execução, você precisará obter a string de conexão. Se estiver usando o MongoDB Atlas, você poderá encontrar a cadeia de conexão nas configurações de conexão do cluster.

Adicione a string de conexão do MongoDB ao seu arquivo .env.local assim:

Configuração do Redis

Usamos Redis para limitação de taxa em nossas rotas de API. Você pode configurar uma instância do Redis de diversas maneiras, incluindo:

• Baixe e instale o Redis diretamente em sua máquina local (não recomendado para usuários do Windows).
• Use um contêiner Docker para executar o Redis.
• Use um serviço Redis gerenciado, como o RedisLabs, que oferece um nível gratuito.

Depois de ter uma instância do Redis em execução, você precisará obter a cadeia de conexão. Se estiver usando o RedisLabs, você poderá encontrar a string de conexão na página de configuração do seu banco de dados.

Instalação

1. Clone este repositório:

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

   ou comece a usar o recurso de modelo do GitHub

2. Navegue até o diretório do projeto:

    cd myChat
   

3. Instale as dependências:

    npm install
   

4. Crie um arquivo .env.local na raiz do projeto e adicione as variáveis ​​de ambiente necessárias:

    touch .env.local
   

   Adicione o seguinte ao arquivo .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
   

Substitua http://localhost:3000 pela porta em que seu aplicativo está sendo executado, yourURI pela string de conexão do MongoDB, yourSecret por uma string aleatória segura, your32HexDigitString por uma string hexadecimal de 32 dígitos para criptografia AES-128 e yourRedisConnectionString pelo seu Redis cadeia de conexão.

...

Uso

• Para executar o servidor de desenvolvimento:

   npm run dev
  

• Para construir o aplicativo para produção:

   npm run build
  

• Para iniciar o servidor de produção:

   npm run start
  

Implantação

Para implantar seu clone myChat no Vercel, siga estas etapas:

1. Cadastre-se para uma conta Vercel, caso ainda não o tenha feito.

2. Instale a CLI do Vercel:

    npm install -g vercel
   

3. Faça login em sua conta Vercel na linha de comando:

    vercel login
   

4. Navegue até o diretório do seu projeto:

    cd myChat
   

5. Execute o seguinte comando para implantar seu aplicativo:

    vercel --prod
   

6. Durante o processo de implantação, o Vercel CLI solicitará as variáveis ​​de ambiente. Forneça os mesmos valores usados ​​para seu arquivo .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
   

Substitua http://localhost:3000 pela porta em que seu aplicativo está sendo executado, yourURI pela string de conexão do MongoDB, yourSecret por uma string aleatória segura, your32HexDigitString por uma string hexadecimal de 32 dígitos para criptografia AES-128 e yourRedisConnectionString pelo seu Redis cadeia de conexão.

7. Assim que a implantação for concluída, Vercel fornecerá a você um URL ativo para acessar seu clone myChat.

Lembre-se de que toda vez que você fizer alterações em seu clone myChat e desejar implantar a versão atualizada, você pode simplesmente executar vercel --prod no diretório do projeto.

Contribuindo

Aceitamos contribuições! Para contribuir, siga estes passos:

1. Bifurque este repositório
2. Clone seu fork em sua máquina local: git clone https://github.com/your-username/myChat.git
3. Crie sua ramificação de recursos: git checkout -b feature/my-new-feature ou git checkout -b fix/my-new-fix
4. Confirme suas alterações: git commit -am 'Add some feature'
5. Push para o branch: git push origin feature/my-new-feature
6. Envie uma solicitação pull

Licença

Este projeto está licenciado sob a licença MIT.