10kbclub

Club de 10 kb

Nota: Este proyecto ya no se mantiene.

Este es el código fuente de 10kbclub.com.

Contenido

• Sugerir un nuevo sitio web
• Configuración de desarrollo
• Cometer directrices
• Detalles adicionales
• Licencia
• Apoyo

Sugerir un nuevo sitio web

Lea las reglas del club primero. Si el nuevo sitio web satisface las reglas del club, cree un nuevo problema y proporcione la URL del sitio web.

Configuración de desarrollo

Para construir y desarrollar este proyecto localmente, realice los siguientes pasos:

1. Clon este repositorio:

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

2. Instalar nodo.

   En MacOS, ingrese el siguiente comando si tiene HomeBrew:

   make mac-setup

   En Debian, Ubuntu u otro sistema Linux con sede en Debian, ingrese el siguiente comando:

    make deb-setup
   

3. Ingrese el siguiente comando para crear una copia local del sitio web:

   make render

4. Ahora abra index.html usando un navegador web para ver la salida.

Actividades de desarrollo

1. En un sistema Linux, ingrese el siguiente comando para asegurarse de que el directorio para binarios de nodo se agregue a la variable de entorno PATH :

    . ./env

2. Ingrese el siguiente comando para generar un archivo llamado metrics.yaml que contenga datos de métricas para cada URL en el archivo src/urls.yaml :

   node src/refresh.js

3. Ingrese el siguiente comando para representar la página de inicio utilizando los datos en metrics.yaml :

   node src/render.js

4. Ingrese el siguiente comando para obtener una sola URL e imprimir sus métricas:

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

   Este script también acepta múltiples argumentos de URL como este:

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

Cometer directrices

Las siguientes pautas se siguen en las confirmaciones realizadas manualmente:

1. Los siguientes comandos deben tener éxito sin errores:

   make checks
   make render

2. Los mensajes de confirmación se escriben según las pautas en este documento: escribir buenos mensajes de confirmación.

Detalles adicionales

Esta sección contiene algunos detalles adicionales que podrían ser útiles para comprender este proyecto.

1. El repositorio del proyecto en https://github.com/susam/10kbclub se publica automáticamente como https://10kbclub.com/ usando las páginas Github.

2. El trabajo de compilación para publicar el sitio web se ejecuta automáticamente una vez todos los sábados, así como en cada impulso a través de acciones de GitHub. Vea live.yml para el flujo de trabajo de GitHub Actions. Consulte https://github.com/susam/10kbclub/actions para las ejecuciones anteriores del flujo de trabajo.

3. Los enlaces a los hilos de discusión en js/urls.yaml no son exhaustivos. Solo los 5 hilos de discusión más antiguos que tienen 100 puntos o más han sido elegidos de cada foro.

Licencia

Este es un software gratuito y de código abierto. Puede usar, copiar, modificar, fusionar, publicar, distribuir, sublicense y/o vender copias de ella, bajo los términos de la licencia MIT. Vea la licencia.md para más detalles.

Este software se proporciona "tal cual", sin garantía de ningún tipo, expresa o implícita. Vea la licencia.md para más detalles.

Apoyo

Para informar errores, sugerir mejoras o hacer preguntas, crear problemas.