pokeapi.co

pokeapi.co

Dieses Repository enthält den Quellcode und die Dokumentation für pokeapi.co. Diese Website basiert auf React-static, einem statischen Site-Generator, der Gatsby ähnelt, außer nicht öffnet und mit weniger Magie.

Erste Schritte

Voraussetzung

• Git
• Knoten: 10.11.0 oder mehr
• Eine Github -Gabel des Repo (für Beiträge)
• Ein Klon des pokeapi.co repo auf Ihrer lokalen Maschine

Installation

1. cd pokeapi.co , um in die Projektwurzel einzusteigen.
2. npm install zur Installation von Projektabhängigkeiten.

Vor Ort laufen

1. npm run start starten Sie den Hot-Reloading-Entwicklungsserver (von React-static).
2. Gehen Sie zu http://localhost:3000 um die Website in Ihrem Browser anzuzeigen.

Gebäude für die Produktion

1. npm run build Um die Produktionsstelle zu erstellen.
2. npm run serve zum Servieren der Produktionsversion der Site auf einem lokalen Testserver.

Produktionsdateien befinden sich im dist -Verzeichnis.

Beitragen

Geben Sie das Projekt auf

1. Geben Sie das Projekt in Ihr eigenes Github -Profil.
2. Klonen Sie das Forked Repository auf Ihre lokale Maschine.
3. git remote add upstream https://github.com/PokeAPI/pokeapi.co um einen Remote -Handle zum Upstream -Repo zu erstellen.
4. git pull upstream master , um sicherzustellen, dass Sie über den neuesten Hauptcode verfügen.
5. git checkout -b branch-name (Ersetzen von Zweignamen durch einen geeigneten Namen), um einen Zweig für Ihre Änderungen zu erstellen.

Die Änderung vornehmen

1. Befolgen Sie die Anweisungen "lokal ausführen".
2. Speichern Sie die Dateien und überprüfen Sie die Ergebnisse im Browser.

Änderungen zu React-Komponenten in /src werden heiß-reladiert. Wenn Sie die Datei oder Dateien /alerts.json im /src/docs/ verzeichnis ändern, müssen Sie den Dev -Server neu starten, bevor Änderungen sichtbar sind.

Testen Sie die Änderung

Testen Sie nach Möglichkeit visuelle Änderungen in allen neuesten Versionen gemeinsamer Browser auf Desktop und Mobile.

Schieben Sie es

1. git add -A um Ihre geänderten Dateien zu inszenieren.
2. git commit -m "My message" (ersetzen meine Nachricht durch eine Commit -Nachricht, z. B. "Header -Logo auf Android beheben"), um Ihre Änderungen zu begehen. Versuchen Sie zwar nicht kritisch wichtig, die Richtlinien zum Schreiben einer Git -Commit -Nachricht zu befolgen.
3. git push my-fork-name branch-name um Ihre Änderungen in Ihr eigenes Github-Repository zu bringen.
4. Gehen Sie zum Pokeapi.co Github Repo und Sie sollten Ihre kürzlich gedrängten Zweige sehen.
5. Befolgen Sie die Anweisungen von Github, um eine Pull -Anfrage einzureichen.
6. Beschreiben Sie die Änderungen, die Sie im Körper des PR vorgenommen haben. Wenn möglich, geben Sie Screenshots visueller Veränderungen an.