opencollective frontend

Open Collective Frontend

Kata pengantar

Jika Anda melihat langkah di bawah ini yang dapat ditingkatkan (atau sudah ketinggalan zaman), harap perbarui instruksi. Kami jarang melalui proses ini sendiri, jadi sepasang mata segar Anda dan pengalaman Anda baru -baru ini, menjadikan Anda kandidat terbaik untuk memperbaikinya bagi pengguna lain. Terima kasih!

Perkembangan

Prasyarat

1. Pastikan Anda memiliki versi node.js 20.x dan NPM versi> = 9.0.0.

• Kami merekomendasikan menggunakan NVM: nvm install && nvm use .

Memasang

Kami merekomendasikan mengkloning repositori dalam folder yang didedikasikan untuk proyek opencollective .

 git clone [email protected]:opencollective/opencollective-frontend.git opencollective/frontend
cd opencollective/frontend
npm install

Variabel Lingkungan

Proyek ini membutuhkan akses ke API Open Collective.

Secara default, ia akan mencoba terhubung ke API pementasan kolektif terbuka, Anda tidak perlu mengubah apa pun .

Jika Anda ingin terhubung ke API Open Collective berjalan secara lokal:

• Klon, instal dan mulai OpenCollective-API
• Dalam proyek ini, salin konten berikut ke file .env :

 API_URL=http://localhost:3060
API_KEY=dvl-1510egmf4a23d80342403fb599qd

Awal

 npm run dev

Tes

Untuk menjalankan tes:

• Untuk halaman dan komponen Gunakan npm test
• Untuk tes end-to-end (E2E) menggunakan Cypress lihat panduan khusus kami.

Untuk memperbarui:

• Snapshot Jest: Jalankan npm run test:update
• File Terjemahan: Jalankan npm run langs:update
• Skema GraphQL untuk Eslint: Jalankan npm run graphql:update

StyleGuide

Kami menggunakan Storybook untuk mengembangkan dan mendokumentasikan komponen reaksi kami secara terpisah dengan komponen gaya dan sistem gaya.

Info lebih lanjut: Docs/StyleGuide.md

Lokalisasi

Menerjemahkan antarmuka tidak memerlukan keterampilan teknis apa pun, Anda dapat menggunakan https://crowdin.com/project/opencollective dan mulai menerjemahkan segera!

Kami sedang mencari kontribusi untuk bahasa berikut:

• Perancis
• Spanyol
• Jepang

Ingin menambahkan bahasa baru untuk Open Collective? Hubungi kami dan kami dengan senang hati membantu Anda mengaturnya!

Berkontribusi

Gaya kode? Melakukan konvensi? Silakan periksa pedoman yang berkontribusi.

TL; DR: Kami menggunakan yang lebih cantik dan eslint, kami sangat menyukai pesan komit hebat dan riwayat git yang bersih.

Hadiah

Repo ini adalah bagian dari program Bounty Open Collective. Dapatkan dibayar untuk berkontribusi ke open source! Tim teknik kolektif terbuka kecil dan kami selalu mencari kontributor baru untuk basis kode sumber terbuka kami. Program hadiah kami adalah kesempatan untuk menyelesaikan masalah yang dapat diabaikan sebaliknya. Kontributor yang memperbaiki masalah ini akan dihargai secara finansial. Silakan lihat dokumen kami untuk informasi lebih lanjut: https://docs.opencollective.com/help/contributing/development/bounties

Penyebaran

Proyek ini saat ini digunakan untuk pementasan dan produksi dengan Heroku. Untuk menggunakan, Anda harus menjadi anggota inti dari tim Open Collective.

Info lebih lanjut: Docs/Deployment.md

Komponen penerbitan

Untuk menerbitkan pembaruan komponen frontend ke NPM, Anda harus menjadi anggota inti dari tim Open Collective. Tangga:

1. Periksa versi yang saat ini diterbitkan dengan npm view @opencollective/frontend-components version
2. Memicu skrip penerbitan dengan menjalankan npm run publish-components {NEW_VERSION} , di mana {NEW_VERSION} adalah nomor versi baru (silakan ikuti semver).
3. Tinjau perubahan, dan konfirmasi jika semuanya masuk akal.

Untuk menambahkan file atau dependensi baru ke paket yang diekspor ini, lihat skrip/publikasi-komponen/config.ts.

Diskusi

Jika Anda memiliki pertanyaan, ping kami di Discord atau Twitter (@Opencollect).

Terima kasih

Berkat Lost Pixel karena menyediakan platform pengujian visual yang membantu kami meninjau perubahan UI dan menangkap regresi visual.