10kbclub

Klub 10 KB

Catatan: Proyek ini tidak lagi dipertahankan.

Ini adalah kode sumber 10kbclub.com.

Isi

• Sarankan situs web baru
• Pengaturan Pembangunan
• Melakukan pedoman
• Detail tambahan
• Lisensi
• Mendukung

Sarankan situs web baru

Baca aturan klub terlebih dahulu. Jika situs web baru memenuhi aturan klub, maka buat masalah baru dan berikan URL situs web.

Pengaturan Pembangunan

Untuk membangun dan mengembangkan proyek ini secara lokal, lakukan langkah -langkah berikut:

1. Klon Repositori ini:

   git clone https://github.com/susam/10kbclub.git

2. Instal Node.

   Di macOS, masukkan perintah berikut jika Anda memiliki homebrew:

   make mac-setup

   Di Debian, Ubuntu, atau sistem Linux berbasis Debian lainnya, masukkan perintah berikut:

    make deb-setup
   

3. Masukkan perintah berikut untuk membuat salinan lokal situs web:

   make render

4. Sekarang buka index.html menggunakan browser web untuk melihat output.

Kegiatan pengembangan

1. Pada sistem Linux, masukkan perintah berikut untuk memastikan bahwa direktori untuk binari simpul ditambahkan ke variabel lingkungan PATH :

    . ./env

2. Masukkan perintah berikut untuk menghasilkan file bernama metrics.yaml yang akan berisi data metrik untuk setiap URL dalam file src/urls.yaml :

   node src/refresh.js

3. Masukkan perintah berikut untuk membuat halaman beranda menggunakan data dalam metrics.yaml :

   node src/render.js

4. Masukkan perintah berikut untuk mengambil satu URL dan cetak metriknya:

   node src/metrics.js https://www.example.com/

   Skrip ini juga menerima beberapa argumen URL seperti ini:

   node src/metrics.js https://www.example.com/ https://www.example.org/

Melakukan pedoman

Pedoman berikut diikuti dalam komitmen yang dibuat secara manual:

1. Perintah berikut harus berhasil tanpa kesalahan:

   make checks
   make render

2. Pesan komit ditulis sesuai pedoman dalam dokumen ini: Menulis pesan komit yang baik.

Detail tambahan

Bagian ini berisi beberapa detail tambahan yang mungkin berguna dalam memahami proyek ini.

1. Repositori proyek di https://github.com/susam/10kbclub secara otomatis diterbitkan sebagai https://10kbclub.com/ menggunakan halaman github.

2. Pekerjaan membangun untuk mempublikasikan situs web berjalan secara otomatis sekali setiap hari Sabtu serta pada setiap dorongan melalui tindakan GitHub. Lihat live.yml untuk alur kerja Github Action. Lihat https://github.com/susam/10kbclub/actions untuk eksekusi alur kerja sebelumnya.

3. Tautan ke utas diskusi di js/urls.yaml tidak lengkap. Hanya 5 utas diskusi paling awal yang memiliki 100 poin atau lebih telah dipilih dari setiap forum.

Lisensi

Ini adalah perangkat lunak gratis dan open source. Anda dapat menggunakan, menyalin, memodifikasi, menggabungkan, menerbitkan, mendistribusikan, sublicense, dan/atau menjual salinannya, berdasarkan ketentuan lisensi MIT. Lihat lisensi.md untuk detailnya.

Perangkat lunak ini disediakan "sebagaimana adanya", tanpa jaminan apa pun, tersurat maupun tersirat. Lihat lisensi.md untuk detailnya.

Mendukung

Untuk melaporkan bug, menyarankan perbaikan, atau mengajukan pertanyaan, membuat masalah.