websegura/README.md
2021-02-04 00:10:37 +01:00

3.1 KiB
Raw Blame History

websegura

Una iniciativa de PucelaBits. Analizamos y mostramos seguridad HTTPS de sitios web públicos, como medida para visualizar aquellos que pueden suponer un riesgo para sus usuarios.

Participa

Añadir una web

Si quieres incluir algún sitio público, puedes crear un nuevo issue o directamente crear un PR editando el fichero de la provincia o comunidad que corresponda en _data/.

Errores o sugerencias

🐞 Abre un nuevo issue para hacernos saber si hay algún error con la web.

💡 Si tienes alguna idea o pregunta para mejorar, podemos debatirla en los foros.

Habla con nosotros

Desarrollo

Si quieres ayudar con el código de la web para mejorarla o añadir nuevas funcionalidades por favor sigue estas instrucciones.

Requisitos

El framework que usamos es Eleventy. Necesitarás git, npm, jq, curl, bash.

sudo apt get install git npm jq curl

Clona el repo

git clone git@github.com:PucelaBits/websegura.git

Ejecutar en local

Instala dependencias

cd websegura
npm install

Ejecuta Eleventy

npx eleventy --serve

Deberías poder acceder a la web en local en http://localhost:8080

Actualizar el análisis de los sitios

Si modificas los listados de URLs, puede actualizar el análisis ejecutando (llevará unos minutos)

npm run crawl

Añadir una nueva provincia

  • Verifica que la comunidad de la provincia existe en _data/comunidades, si no, créala.
  • Crea el archivo de la provincia en _data/provincias (usa uno existente como plantilla).

Enviar tus modificaciones

🐞 Por favor, abre primero un issue para describir el problema que vas a solucionar e indica que vas ponerte con ello.

Si quieres implementar una nueva funcionalidad, por favor, crea un nuevo issue antes de hacer nada. Queremos asegurarnos que las nuevas funcionalidades tienen consenso antes de aceptarlas y que alguien trabaje en el código.

Manda un pull request siempre con el menor numero de commits posible, referencia en los commits y el PR qué issue estás resolviendo (Fix #numero).

Si tienes alguna duda, puedes escribirnos en cualquiera de los canales listados más arriba.