Implantar

Configuração e Personalização

AI Short é um projeto de código aberto que você pode personalizar conforme suas necessidades. Abaixo estão as opções de personalização comuns e suas instruções:

• Alterar Título e Descrição do Site
  Para atualizar o título e a descrição do site, edite o arquivo de configuração docusaurus.config.js.

• Modificar Instruções de Uso e Introdução
  As instruções de uso e a introdução do projeto podem ser encontradas no diretório docs. Abra os arquivos relevantes e faça as alterações necessárias.

• Alterar Prompt da Página Inicial
  Os prompts da página inicial são armazenados no arquivo src/data/prompt.json. Para modificar prompts em idiomas específicos, como o português, edite diretamente o arquivo src/data/prompt_pt.json. Para adicionar um novo prompt, use o seguinte formato:

  {
    "pt": {
      "title": "custom prompt",
      "prompt": "custom prompt",
      "description": "custom description",
      "remark": "custom mark"
    },
    "website": null,
    "tags": [
      "music"
    ],
    "id": 500, 
    "weight": 1
  }

  Observação: Recomenda-se definir o id como 500 ou superior. Novos prompts não terão páginas ou seções de comentários dedicadas. Se você deseja uma página dedicada para um prompt, pode copiar os arquivos de modelo do diretório src/data/pages/prompt e modificá-los.

• Personalizar Backend
  O projeto está atualmente conectado a um sistema de backend compartilhado. Se você deseja configurar seu próprio backend, consulte a documentação da API no arquivo src/api.js.

• Suporte Multilíngue e Implantação
  Após atualizar os arquivos de idioma, você pode usar o script CodeUpdateHandler.py para processamento em lote. Execute o seguinte comando:

  python CodeUpdateHandler.py

  Este script irá dividir o arquivo prompt.json com base nas regras predefinidas e atualizar a página inicial e a página de prompts em destaque para todas as versões de idioma.

Instruções de Deploy

Requisitos do Sistema:

• Node.js 18.0 ou versão superior.
• macOS, Windows (incluindo WSL) e Linux são compatíveis.

Deploy Local

Certifique-se de que você tem o Node.js instalado.

# Instalação
yarn

# Desenvolvimento Local
yarn start

# Build: Este comando gera o conteúdo estático no diretório `build`
yarn build

# Atualize o `defaultLocale` no arquivo `docusaurus.config.js`, e em seguida faça o build para o idioma desejado.
yarn build --locale zh
yarn build --locale en
yarn build --locale ja
yarn build --locale ko
yarn build --locale es
yarn build --locale fr
yarn build --locale de
yarn build --locale it
yarn build --locale ru
yarn build --locale pt
yarn build --locale hi
yarn build --locale ar
yarn build --locale bn

# Deploy para múltiplos idiomas
yarn build --locale zh && yarn build --locale en

Deploy no Vercel

Clique no botão abaixo para fazer o deploy do ChatGPT-Shortcut na plataforma Vercel com um clique:

Atenção: A versão gratuita do Vercel pode apresentar erros devido à falta de memória. Se isso ocorrer, você pode optar por realizar o deploy de uma versão com um único idioma. Os passos são os seguintes:

1. Acesse o projeto recém-deployado no Vercel e abra as Configurações.
2. Na seção Build & Deployment, encontre Build Command e clique em Override à direita.
3. Modifique o comando de deploy. Por exemplo, para deploy da versão em chinês, use yarn build --locale zh; para a versão em português, use yarn build --locale pt.

Deploy no Cloudflare Pages

Clique no botão ou link abaixo para fazer o fork deste projeto e depois siga as instruções para realizar o deploy no Cloudflare Pages:

👉 Fork este projeto

Passos para o Deploy:

1. Faça login no Cloudflare Pages e selecione "Create a project".
2. Conecte o repositório que você acabou de forkar.
3. Configure o comando de build:
   • Build command: yarn build --locale zh (escolha o locale adequado para o idioma que você quer deployar; para o português, use yarn build --locale pt).
   • Output directory: build.
4. Clique em Deploy e aguarde o Cloudflare Pages finalizar o processo de build e deploy.

O Cloudflare Pages também irá disparar automaticamente o build e o deploy sempre que você enviar novos códigos.

Implantação do Docker

Se você estiver familiarizado com o Docker, poderá implantar rapidamente com o seguinte comando:

# ghcr.io
docker run -d -p 3000:3000 --name chatgpt-shortcut ghcr.io/rockbenben/chatgpt-shortcut:latest

# docker hub
docker run -d -p 3000:3000 --name chatgpt-shortcut rockben/chatgpt-shortcut:latest

Alternativamente, você pode usar docker-compose:

version: "3.8"

services:
docsify:
container_name: chatgpt-shortcut
image: ghcr.io/rockbenben/chatgpt-shortcut:latest
ports:
- "3000:3000"
restart: unless-stopped

Atualizações sincronizadas

Se você implantou seu próprio projeto no Vercel com um único clique, pode encontrar um problema em que as atualizações são consistentemente indicadas. Isso surge do comportamento padrão do Vercel de criar um novo projeto para você em vez de bifurcar o projeto atual, impedindo assim a detecção adequada de atualizações. É recomendável seguir as etapas subsequentes para a reimplantação:

1. Remova o repositório anterior.
2. Utilize o botão "fork" localizado no canto superior direito da página para bifurcar o projeto atual.
3. Na página Vercel New Project, selecione o projeto bifurcado recentemente na seção Import Git Repository e prossiga com a implantação.

Atualizações Automáticas

No caso de encontrar um erro durante a execução do Upstream Sync, execute manualmente um único Sync Fork.

Depois de bifurcar o projeto, devido às restrições do GitHub, é necessário habilitar manualmente os Workflows na página Actions do seu projeto bifurcado e ativar a Upstream Sync Action. Após a ativação, as atualizações serão executadas automaticamente diariamente.

Atualizações manuais

Se você deseja atualizar manualmente imediatamente, pode consultar a documentação do GitHub para aprender como sincronizar o projeto bifurcado com o código upstream.

Sinta-se à vontade para mostrar apoio a este projeto dando uma estrela/seguindo, ou seguindo o autor, para se manter informado sobre notificações oportunas sobre novas atualizações de recursos.