PucelaBits / websegura

Analizamos y mostramos seguridad HTTPS de sitios web públicos, como medida para visualizar aquellos que pueden suponer un riesgo para sus usuarios.
https://websegura.pucelabits.org/
GNU Affero General Public License v3.0
29 stars 34 forks source link
encryption https opendata

websegura

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

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

Pautas para la participación

Este repositorio se rige por el código de conducta y etiqueta de PucelaBits.

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 y nodejs 14+.

sudo apt get install git nodejs

Si quieres ejecutar el script para hacer el análisis de las webs, también necesitarás jq y curl.

sudo apt get install jq curl

Clona el repositorio:

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

Ejecutar en local

Instala dependencias

cd websegura
npm install

Levanta el servidor de desarrollo

npm start

Deberías poder acceder a la web en local en http://localhost:8080. Mientras dejes el proceso abierto, los cambios que hagas en el código se irán compilando automáticamente y podrás verlos recargando en el navegador.

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

El análisis se ejecuta automáticamente cada día y tras cada nuevo commit a la rama principal, por lo que no es necesario hacer commit de los ficheros generados.

Añadir una nueva provincia

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.