Pa11y Dashboard to interfejs sieciowy do automatycznego narzędzia raportowania dostępności Pa11y; który pozwala skupić się na naprawianiu problemów, a nie na ich szukaniu.
Pa11y Dashboard to aplikacja Node.js, która wymaga stabilnej lub LTS wersji Node, obecnie w wersji 12 lub 14.
Pa11y Dashboard wykorzystuje do przechowywania wyników testów bazę danych MongoDB. Baza danych nie musi znajdować się na tym samym serwerze lub komputerze, z którego działa Pa11y Dashboard.
Pa11y Dashboard używa puppeteer do stworzenia bezgłowej instancji przeglądarki Chromium w celu przeprowadzenia testów. W niektórych środowiskach może to wymagać zainstalowania dodatkowych zależności. Na przykład w systemach Debian/Ubuntu może być konieczne zainstalowanie bibliotek libnss3 i libgconf-2-4, aby móc uruchamiać testy na Pa11y Dashboard. Aby uzyskać szczegółowe informacje, jak to zrobić, zapoznaj się z dokumentacją dostawcy.
Aby uruchomić Pa11y Dashboard, zalecamy sklonowanie tego repozytorium lokalnie:
git clone https://github.com/pa11y/pa11y-dashboard.gitNastępnie zainstaluj zależności:
cd pa11y-dashboard
npm installInstrukcje dotyczące instalowania i uruchamiania MongoDB wykraczają poza zakres tego dokumentu. W razie wątpliwości zapoznaj się z instrukcją instalacji MongoDB aby uzyskać szczegółowe informacje o tym, jak zainstalować i uruchomić MongoDB w swoim systemie operacyjnym. Poniżej przedstawiono przykład procesu instalacji i konfiguracji systemu macOS.
Pa11y Dashboard korzysta obecnie z wersji 3 sterownika MongoDB Node.js, co oznacza, że tylko serwery MongoDB w wersji 4.4 lub starszej są obsługiwane. Przed próbą uruchomienia Pa11y Dashboard upewnij się, że Twój serwer MongoDB spełnia wymagania.
W najnowszych wersjach systemu macOS (10.13 lub nowszej) możesz użyć Homebrew, aby zainstalować MongoDB Community Edition. Nowsze wersje MongoDB są nieprzetestowane i nie są obsługiwane.
Stuknij w MongoDB Homebrew:
brew tap mongodb/brewZainstaluj obsługiwaną społecznościową wersję MongoDB:
brew install [email protected]Uruchom serwer MongoDB:
brew services start mongodb/brew/[email protected]Sprawdź, czy usługa została poprawnie uruchomiona:
$ brew services list
Name Status User Plist
mongodb-community started pa11y /Users/pa11y/Library/LaunchAgents/homebrew.mxcl.mongodb-community.plistOstatnim krokiem przed uruchomieniem Pa11y Dashboard jest zdefiniowanie dla niego konfiguracji. Można to zrobić na dwa sposoby:
Każdą konfigurację można ustawić za pomocą zmiennej środowiskowej, a nie pliku konfiguracyjnego. Na przykład, aby uruchomić aplikację na porcie8080, możesz użyć następujących opcji:
PORT=8080 node index.jsDostępne konfiguracje są udokumentowane w następnej sekcji.
Możesz zapisać konfigurację Pa11y Dashboard w pliku JSON. Możesz użyć różnych plików konfiguracyjnych dla każdego środowiska, w którym planujesz uruchomić Pa11y Dashboard. Możesz wybrać konkretne środowisko do uruchomienia aplikacji, ustawiając zmienną środowiskową NODE_ENV:
NODE_ENV=development node index.jsW tym repozytorium znajdują się trzy przykładowe pliki, które można skopiować i dostosować do własnych upodobań:
cp config/development.sample.json config/development.json
cp config/production.sample.json config/production.json
cp config/test.sample.json config/test.jsonDostępne konfiguracje są udokumentowane w następnej sekcji.
Jeśli napotkasz problemy, sprawdź [przewodnik rozwiązywania problemów][#rozwiazywanie-problemow].
(liczba) Port, na którym ma zostać uruchomiona aplikacja. Ustaw za pomocą pliku konfiguracyjnego lub zmiennej środowiskowej PORT.
(boolean) Jeśli ustawione na true (domyślnie), pulpit nie będzie indeksowany przez wyszukiwarki. Ustaw false, aby zezwolić na indeksowanie. Ustaw za pomocą pliku konfiguracyjnego lub zmiennej środowiskowej NOINDEX.
(boolean) Jeśli ustawione na true, użytkownicy nie będą mogli dodawać, usuwać ani uruchamiać adresów URL (domyślnie false). Ustaw za pomocą pliku konfiguracyjnego lub zmiennej środowiskowej READONLY.
(string) Wiadomość, która ma być wyświetlana w widocznym miejscu na stronie głównej witryny. Domyślnie null.
Może to być obiekt zawierający konfiguracje Pa11y Webservice lub ciąg będący podstawowym adresem URL instancji [Pa11y Webservice][pa11y-webservice], którą uruchamiasz oddzielnie. Jeśli używasz zmiennych środowiskowych, poprzedź vars usługi sieci Web prefiksem WEBSERVICE_.
Istnieje wiele sposobów wniesienia wkładu do Pa11y Dashboard, omówimy je w przewodniku dotyczącym wkładu dla tego repozytorium.
Jeśli chcesz udostępnić trochę kodu, musisz sklonować repozytorium i skonfigurować zgodnie z opisem w przewodniku konfiguracji. YNastępnie musisz uruchomić aplikację w trybie testowym za pomocą:
NODE_ENV=test node index.jsBędziesz teraz mógł uruchamiać następujące polecenia:
make verify # Zweryfikuj cały kod (ESLint)
make test # Uruchom wszystkie testy
make test-integration # Uruchom testy integracyjneAby skompilować JavaScript i CSS po stronie klienta, potrzebujesz następujących poleceń. Skompilowany kod jest przekazywany do repozytorium.
make less # Skompiluj CSS strony z plików LESS
make uglify # Skompiluj i zbuguj JavaScript po stronie klienta- Konfigurowanie pulpitu dostępności od podstaw za pomocą Pa11y na DigitalOcean
- Monitorowanie zgodności z dostępnością internmetową za pomocą Pa11y Dashboard
- Błędy
500lubCould not connect to pa11y-webservice: komunikaty są często związane z MongoDB. Upewnij się, że masz zainstalowaną [odpowiednią wersję MongoDB][#installing-mongodb] i że baza działa — nie zawsze uruchamia się automatycznie. - Komunikaty o błędach mówiące, że
pa11y-webservice isn't running, mogą być spowodowane problemami z instalacją zależności. Spróbuj usunąć katalogpa11y-dashboard/node_modulesi uruchomić ponownienpm install.
Sprawdź issue tracker pod kątem podobnych problemów przed utworzeniem nowego. Jeśli występujący problem nie jest objęty jednym z istniejących problemów, możesz utworzyć nowy problem. Podaj numery wersji node.js i MongoDB oraz swój system operacyjny, a także wszelkie informacje, które mogą być przydatne podczas debugowania problemu.
Główne wersje Pa11y Dashboard są zwykle obsługiwane przez 6 miesięcy od ich ostatniego wydania pomocniczego. Oznacza to, że zostaną dodane zmiany na poziomie łatek, a błędy zostaną naprawione. W poniższej tabeli przedstawiono daty zakończenia wsparcia dla wersji głównych oraz ostatnią wersję pomocniczą dla tej wersji.
Twórca utrzymuje również przewodnik migracji, który pomoże Ci przeprowadzić migrację.
| ❔ | Wersja główna | Ostatnie mniejsze wydanie | Wersje Node.js | koiec wsparcia |
|---|---|---|---|---|
| ❤️ | 4 | N/A | 12+ | N/D |
| ⌛ | 3 | 3.3.0 | 8+ | 2022-05-26 |
| 💀 | 2 | 2.4.2 | 4+ | 2020-01-16 |
| 💀 | 1 | 1.12 | 0.10–6 | 2016-12-05 |
Jeśli otwierasz problemy z nimi związane, podaj wersję, której dotyczy problem.
Pa11y Dashboard jest objęty licencją GNU General Public License 3.0.
Copyright © 2013–2020, Zespół Pa11y i współpracownicy