pokeapi.co

pokeapi.co

Repositori ini berisi kode sumber dan dokumentasi untuk pokeAPi.co. Situs web ini dibangun di atas React-Static, generator situs statis yang mirip dengan Gatsby, kecuali tidak teropini dan dengan sedikit keajaiban.

Memulai

Prasyarat

• Git
• Node: 10.11.0 atau lebih
• Garpu github dari repo (untuk setiap kontribusi)
• Klon dari repo PokeAPI.co di mesin lokal Anda

Instalasi

1. cd pokeapi.co untuk masuk ke root proyek.
2. npm install untuk menginstal dependensi proyek.

Berjalan secara lokal

1. npm run start untuk memulai server pengembangan hot-reloading (ditenagai oleh React-Static).
2. Pergi ke http://localhost:3000 untuk melihat situs di browser Anda.

Membangun untuk produksi

1. npm run build untuk membangun situs produksi.
2. npm run serve untuk melayani versi produksi situs di server uji lokal.

File produksi terletak di direktori dist .

Berkontribusi

Garpu proyek

1. Fork Project ke profil GitHub Anda sendiri.
2. Kloning repositori bercabang ke mesin lokal Anda.
3. git remote add upstream https://github.com/PokeAPI/pokeapi.co untuk membuat pegangan jarak jauh ke repo hulu.
4. git pull upstream master untuk memastikan Anda memiliki kode utama terbaru.
5. git checkout -b branch-name (mengganti nama cabang dengan nama yang sesuai) untuk membuat cabang untuk perubahan Anda.

Membuat perubahan

1. Ikuti instruksi "berjalan secara lokal".
2. Simpan file dan periksa hasil di browser.

Perubahan pada komponen bereaksi di /src akan memuat ulang panas. Jika memodifikasi file atau file /alerts.json di /src/docs/ direktori, Anda perlu memulai kembali server dev sebelum perubahan akan terlihat.

Uji perubahan

Jika memungkinkan, uji perubahan visual apa pun dalam semua versi terbaru dari browser umum, baik di desktop dan seluler.

Dorong

1. git add -A Untuk menggelar file yang Anda ganti.
2. git commit -m "My message" (mengganti pesan saya dengan pesan komit, seperti "Fix Header Logo di Android") untuk melakukan perubahan Anda. Meskipun tidak terlalu penting, cobalah untuk mengikuti pedoman tentang cara menulis pesan Git Commit.
3. git push my-fork-name branch-name untuk mendorong perubahan Anda ke repositori github Anda sendiri.
4. Pergi ke repo PokeAPI.co GitHub dan Anda akan melihat cabang yang baru saja didorong.
5. Ikuti instruksi GitHub untuk mengirimkan permintaan tarik.
6. Jelaskan perubahan yang Anda buat di tubuh PR. Jika memungkinkan, sertakan tangkapan layar perubahan visual.