Skip to content

README.pt.md

Latest commit

 

History

History
153 lines (101 loc) · 5.49 KB

README.pt.md

File metadata and controls

153 lines (101 loc) · 5.49 KB

⚠️ Nota de tradução: Este documento foi traduzido por IA. Se encontrar algum erro, por favor indique. Obrigado!

Este projeto é um fork de star-history/star-history e foi aprimorado. Não fará merge do código de volta ao projeto original. O projeto atualiza a implementação do gráfico e introduz o MongoDB para cache de dados, reduzindo chamadas à API do GitHub e melhorando o desempenho. Tema escuro adicionado.

✨ gitdata analysis ✨

gitdata.xuanhun520.com, fornece capacidades de estatísticas e visualização de dados ausentes para repositórios GitHub, como a funcionalidade de gráfico de histórico de estrelas.

Star History Chart

👆 ESTE é um gráfico ao vivo criado com o seguinte código HTML: 👇

<picture>
  <source media="(prefers-color-scheme: dark)" srcset="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date&theme=dark" />
  <source media="(prefers-color-scheme: light)" srcset="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date" />
  <img style="width: 800px; height: 533px;" alt="Star History Chart" src="https://gitdata.xuanhun520.com/api/starimg?repos=visactor/vchart&type=Date" />
</picture>

✨ Recursos

  • Baseado em VChart.
  • Suporte para visualizar dados detalhados
  • Geração com um clique de imagens de gráficos de alta qualidade;
  • Suporte para múltiplos modos de visualização de gráficos, baseados em data ou linha do tempo;
  • Incorporar gráficos em tempo real em GitHub readme ou outros sites (como o exemplo que incorporamos no topo);
  • E várias funções úteis:
    • Alternar visibilidade do repositório;
    • Atalho para inserir o nome do repositório;
    • Compartilhamento rápido para redes sociais;
    • Suporte para inserir múltiplos repositórios;
    • ...mais recursos esperando para você descobrir!

🌠 Capturas de tela

🏗 Desenvolvimento

Star-history é construído usando uma pilha tecnológica moderna: Vue + Vite + TailwindCSS + @Visactor/VChart.

Pré-requisitos

Instalar dependências

pnpm i

Iniciar desenvolvimento

  • Site principal é a página inicial do gitdata, contendo a maioria das funcionalidades úteis e blogs sobre VisActor open source.

    pnpm dev

    O site será servido em http://localhost:3000.

  • Servidor API é uma funcionalidade experimental. É usado principalmente para gerar arquivos de imagem de gráficos SVG ou PNG que podem ser incorporados em GitHub readme.

    Pré-requisitos para o servidor API

    Instalar MongoDB Community Server

    Nota: Após alterar a senha, lembre-se de atualizar a string de conexão no seu arquivo .env ou variáveis de ambiente.

    Definir variáveis de ambiente:

    A configuração do MongoDB pode ser modificada de acordo com sua situação real.

    # Definir string de conexão MongoDB
export MONGODB_URI="mongodb://[username]:[password]@localhost:27017/gitdata"
export MONGODB_DB_NAME="gitdata"
export MONGODB_COLLECTION_NAME="repo_cache"

    Ou criar um arquivo .env no diretório server:

    MONGODB_URI=mongodb://xuanhun:xuanhun@localhost:27017/gitdata
MONGODB_DB_NAME=gitdata
MONGODB_COLLECTION_NAME=repo_cache

    Iniciar servidor API

    cd server
pnpm i && pnpm dev

    O servidor API estará em execução em http://localhost:8080 (ou https://localhost:8080 se HTTPS estiver habilitado).

    Token

    O serviço backend requer seu próprio token GitHub, colocado no arquivo token.env.

    Habilitar suporte HTTPS

    Para habilitar HTTPS para o frontend:

    1. Gerar certificados SSL (para desenvolvimento):

      ./scripts/generate-ssl-cert.sh

      Isso criará certificados autoassinados no diretório certs/.

    2. Para Frontend (Vite):

      O servidor de desenvolvimento Vite usará automaticamente HTTPS se certificados forem encontrados no diretório certs/, ou você pode especificar caminhos personalizados:

      export SSL_CERT_PATH=/path/to/cert.crt
export SSL_KEY_PATH=/path/to/key.key
pnpm dev

Planos futuros

  • Adicionar mais recursos de edição e anotação
  • Visualizar e editar código VChart, exportar para o editor oficial VChart
  • Gerar vídeos animados do histórico de estrelas (GIF)
  • Mais estatísticas e recursos de análise de dados do GitHub