10kbclub

10 KB Club

Nota: Este projeto não é mais mantido.

Este é o código -fonte de 10kbclub.com.

Conteúdo

• Sugira um novo site
• Configuração de desenvolvimento
• Cometer diretrizes
• Detalhes adicionais
• Licença
• Apoiar

Sugira um novo site

Leia as regras do clube primeiro. Se o novo site satisfazer as regras do clube, crie um novo problema e forneça o URL do site.

Configuração de desenvolvimento

Para construir e desenvolver este projeto localmente, execute as seguintes etapas:

1. Clone este repositório:

   git clone https://github.com/susam/10kbclub.git

2. Instale o nó.

   No macOS, insira o seguinte comando se você tiver homebrew:

   make mac-setup

   No Debian, Ubuntu, ou outro sistema Linux, baseado no Debian, digite o seguinte comando:

    make deb-setup
   

3. Digite o seguinte comando para criar uma cópia local do site:

   make render

4. Agora open index.html usando um navegador da web para ver a saída.

Atividades de desenvolvimento

1. Em um sistema Linux, insira o seguinte comando para garantir que o diretório para binários de nó seja adicionado à variável do ambiente PATH :

    . ./env

2. Digite o seguinte comando para gerar um arquivo chamado metrics.yaml que conteria dados de métricas para cada URL no arquivo src/urls.yaml :

   node src/refresh.js

3. Digite o seguinte comando para renderizar a página inicial usando os dados em metrics.yaml :

   node src/render.js

4. Digite o seguinte comando para buscar um único URL e imprima suas métricas:

   node src/metrics.js https://www.example.com/

   Este script também aceita vários argumentos de URL como este:

   node src/metrics.js https://www.example.com/ https://www.example.org/

Cometer diretrizes

As seguintes diretrizes são seguidas nos comprometimentos feitos manualmente:

1. Os seguintes comandos devem ter sucesso sem erros:

   make checks
   make render

2. As mensagens de confirmação são escritas de acordo com as diretrizes deste documento: escrever boas mensagens de compromisso.

Detalhes adicionais

Esta seção contém alguns detalhes adicionais que podem ser úteis para entender este projeto.

1. O repositório do projeto em https://github.com/susam/10kbclub é publicado automaticamente como https://10kbclub.com/ usando páginas do github.

2. O trabalho de construção para publicar o site é executado automaticamente uma vez todos os sábados, bem como em todos os esforços por meio de ações do GitHub. Consulte live.yml para o fluxo de trabalho Ações do GitHub. Consulte https://github.com/susam/10kbclub/actions para as execuções anteriores do fluxo de trabalho.

3. Os links para tópicos de discussão em js/urls.yaml não são exaustivos. Somente os 5 threads de discussão mais antigos que tiveram 100 pontos ou mais foram escolhidos em cada fórum.

Licença

Este é um software gratuito e de código aberto. Você pode usar, copiar, modificar, mesclar, publicar, distribuir, sublicense e/ou vender cópias dele, nos termos da licença do MIT. Consulte License.md para obter detalhes.

Este software é fornecido "como está", sem garantia de qualquer tipo, expresso ou implícito. Consulte License.md para obter detalhes.

Apoiar

Para relatar bugs, sugira melhorias ou faça perguntas, crie problemas.