10kbclub

10 КБ клуб

Примечание: этот проект больше не поддерживается.

Это исходный код 10KBClub.com.

Содержимое

• Предложить новый сайт
• Настройка разработки
• Руководящие принципы
• Дополнительные детали
• Лицензия
• Поддерживать

Предложить новый сайт

Сначала прочитайте клубные правила. Если новый веб -сайт удовлетворяет правилам клуба, создайте новую проблему и предоставьте URL -адрес веб -сайта.

Настройка разработки

Чтобы создать и разрабатывать этот проект локально, выполните следующие шаги:

1. Клонировать это хранилище:

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

2. Установите узел.

   В MacOS введите следующую команду, если у вас есть HomeBrew:

   make mac-setup

   На Debian, Ubuntu или другой системе Linux на основе Debian введите следующую команду:

    make deb-setup
   

3. Введите следующую команду для создания локальной копии веб -сайта:

   make render

4. Теперь откройте index.html используя веб -браузер, чтобы увидеть вывод.

Занятия по развитию

1. В систему Linux введите следующую команду, чтобы убедиться, что каталог для двоичных файлов узлов добавляется к переменной среды PATH :

    . ./env

2. Введите следующую команду, чтобы сгенерировать файл с именем metrics.yaml , который будет содержать данные метрик для каждого URL в файле src/urls.yaml :

   node src/refresh.js

3. Введите следующую команду, чтобы отобразить домашнюю страницу, используя данные в metrics.yaml :

   node src/render.js

4. Введите следующую команду, чтобы принести один URL и распечатать его метрики:

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

   Этот сценарий также принимает несколько аргументов URL, подобных этим:

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

Руководящие принципы

Следующие руководящие принципы соблюдаются в коммитах, сделанных вручную:

1. Следующие команды должны добиться успеха без ошибок:

   make checks
   make render

2. Сообщения о коммите написаны в соответствии с руководящими принципами в этом документе: написание хороших сообщений о коммите.

Дополнительные детали

Этот раздел содержит некоторые дополнительные детали, которые могут быть полезны для понимания этого проекта.

1. Репозиторий проекта по адресу https://github.com/susam/10kbclub автоматически публикуется как https://10kbclub.com/ с использованием страниц github.

2. Работа по сборке для публикации веб -сайта работает автоматически один раз в субботу, а также на каждом толчке с помощью действий GitHub. См. live.yml для рабочего процесса действий GitHub. См.

3. Ссылки на потоки обсуждения в js/urls.yaml не являются исчерпывающими. Только 5 самых ранних обсуждений, в которых содержится 100 или более очков, были выбраны на каждом форуме.

Лицензия

Это бесплатное программное обеспечение с открытым исходным кодом. Вы можете использовать, копировать, модифицировать, объединять, публиковать, распространять, сублиценс и/или продавать его копии, в соответствии с условиями лицензии MIT. Смотрите License.md для деталей.

Это программное обеспечение предоставляется «как есть», без гарантии любого рода, явного или подразумеваемого. Смотрите License.md для деталей.

Поддерживать

Чтобы сообщить об ошибках, предложить улучшения или задавать вопросы, создать проблемы.