Update README.md
This commit is contained in:
parent
34b58b03d0
commit
362b7247b8
55
README.md
55
README.md
|
@ -1,32 +1,55 @@
|
|||
# green-spider
|
||||
# Green Spider
|
||||
|
||||
Collects data on green websites and checks for things like SEO, performance, TLS.
|
||||
Initiative und Tools zur Förderung eines benutzer*innenfreundlichen Auftritts von Bündnis 90/Die Grünen im Web
|
||||
|
||||
Written and tested in Python3
|
||||
## Tools
|
||||
|
||||
Results published at https://netzbegruenung.github.io/green-spider/
|
||||
- Spider: Sammelt Informationen über Websites von B90/GRÜNE Gliederungen
|
||||
|
||||
### Usage
|
||||
- Webapp: Darstellung der Spider-Ergebnisse unter [netzbegruenung.github.io/green-spider/](https://netzbegruenung.github.io/green-spider/)
|
||||
|
||||
Run the spider:
|
||||
## Aktivitäten
|
||||
|
||||
Es ist geplant, auf Basis der gesammelten Informationen (siehe Spider) Informationen an die Betreiber*innen der Websites zu versenden. Hierzu müssen Prozesse erarbeitet und vermutlich weitere Tools geschaffen werden.
|
||||
|
||||
## Community
|
||||
|
||||
Green Spider ist ein Projekt des [netzbegrünung](https://blog.netzbegruenung.de/) e. V. Mitwirkung ist herzlich willkommen.
|
||||
|
||||
Zur Kommunikation dient der Chatbegrünung-Kanal [#green-spider](https://chatbegruenung.de/channel/green-spider) sowie die Issues hier in diesem Repository.
|
||||
|
||||
## Anleitung
|
||||
|
||||
### Spider ausführen
|
||||
|
||||
Damit werden alle bekannten WWW-Adressen aus [netzbegruenung/green-directory](https://github.com/netzbegruenung/green-directory) geprüft und Daten dazu gesammelt.
|
||||
|
||||
Voraussetzungen:
|
||||
|
||||
- GNU make
|
||||
- Python 3
|
||||
- virtualenv
|
||||
|
||||
Starte den Vorgang mit diesem Befehl:
|
||||
|
||||
```nohighlight
|
||||
make spider
|
||||
```
|
||||
|
||||
The result will be in `webapp/dist/data`.
|
||||
Das Ergebnis ist die Datei `webapp/dist/data/spider_result.json`. Wenn Du die neuen Daten ins Repository einspielen möchtest, erstelle bitte einen Pull Request.
|
||||
|
||||
Build the webapp:
|
||||
### Webapp aktualisieren
|
||||
|
||||
Die unter https://netzbegruenung.github.io/green-spider/ veröffentlichte Webapp zeigt den Inhalt des [docs](https://github.com/netzbegruenung/green-spider/tree/master/docs) Verzeichnisses für den `master` Branch dieses repositories an. Dieser kann automatisch neu erzeugt werden.
|
||||
|
||||
Voraussetzungen:
|
||||
|
||||
- npm
|
||||
|
||||
Um den Inhalt des docs-Verzeichnisses zu aktualisieren, gibt es im Makefile dieses Kommando:
|
||||
|
||||
```nohighlight
|
||||
make webapp
|
||||
```
|
||||
|
||||
### Ideas
|
||||
|
||||
- Check which cookies are set and with what settings (expiry, domain)
|
||||
- submit the URL against a service like Google Page Speed and retrieve the score (see https://github.com/addyosmani/psi/)
|
||||
- Check against our own webpagetest.org instance
|
||||
- Detect which one of the well-known CMS is used
|
||||
- Warn in case a certificate will expire soon
|
||||
- Favourite icon availability check
|
||||
Das Ergebniss sollte als Pull Request beigesteuert werden.
|
||||
|
|
Loading…
Reference in New Issue