10kbclub

Club de 10 kb

Remarque: Ce projet n'est plus maintenu.

Ceci est le code source de 10kbclub.com.

Contenu

• Suggérer un nouveau site Web
• Configuration du développement
• Commettre des lignes directrices
• Détails supplémentaires
• Licence
• Soutien

Suggérer un nouveau site Web

Lisez d'abord les règles du club. Si le nouveau site Web satisfait les règles du club, créez un nouveau problème et fournissez l'URL du site Web.

Configuration du développement

Pour construire et développer ce projet localement, effectuez les étapes suivantes:

1. Cloner ce référentiel:

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

2. Installez le nœud.

   Sur macOS, entrez la commande suivante si vous avez Homebrew:

   make mac-setup

   Sur Debian, Ubuntu ou un autre système Linux basé à Debian, entrez la commande suivante:

    make deb-setup
   

3. Entrez la commande suivante pour créer une copie locale du site Web:

   make render

4. Open Open index.html à l'aide d'un navigateur Web pour voir la sortie.

Activités de développement

1. Sur un système Linux, entrez la commande suivante pour vous assurer que le répertoire des binaires de nœuds est ajouté à la variable d'environnement PATH :

    . ./env

2. Entrez la commande suivante pour générer un fichier nommé metrics.yaml qui contiendrait des données de métriques pour chaque URL du fichier src/urls.yaml :

   node src/refresh.js

3. Entrez la commande suivante pour rendre la page d'accueil à l'aide des données dans metrics.yaml :

   node src/render.js

4. Entrez la commande suivante pour récupérer une seule URL et imprimer ses métriques:

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

   Ce script accepte également plusieurs arguments URL comme ceci:

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

Commettre des lignes directrices

Les directives suivantes sont suivies dans les commits réalisés manuellement:

1. Les commandes suivantes doivent réussir sans erreurs:

   make checks
   make render

2. Les messages de validation sont écrits conformément aux directives de ce document: écrire de bons messages de validation.

Détails supplémentaires

Cette section contient quelques détails supplémentaires qui pourraient être utiles pour comprendre ce projet.

1. Le référentiel de projet à https://github.com/susam/10kbclub est automatiquement publié sous le nom de https://10kbclub.com/ à l'aide de pages github.

2. Le travail de construction pour publier le site Web s'exécute automatiquement une fois tous les samedis ainsi qu'à chaque poussée via les actions GitHub. Voir live.yml pour le flux de travail des actions GitHub. Voir https://github.com/susam/10kbclub/actions pour les exécutions précédentes du workflow.

3. Les liens vers les threads de discussion dans js/urls.yaml ne sont pas exhaustifs. Seuls les 5 premiers fils de discussion qui ont 100 points ou plus ont été choisis dans chaque forum.

Licence

Il s'agit d'un logiciel gratuit et open source. Vous pouvez utiliser, copier, modifier, fusionner, publier, distribuer, sous-licencier et / ou en vendre des copies, selon les termes de la licence MIT. Voir Licence.MD pour plus de détails.

Ce logiciel est fourni "tel quel", sans garantie d'aucune sorte, express ou implicite. Voir Licence.MD pour plus de détails.

Soutien

Pour signaler des bogues, suggérer des améliorations ou poser des questions, créez des problèmes.