Руководство по установке

Требования к системе

Для использования плеера требуется операционная система поддерживающая работу Node.js. Например: FreeBSD или Debian

Установка Node.js

Для работы ПО в систему необходимо установить Node.js не ниже 16 версии. Для установки можно воспользоваться официальными установщиками, через пакетные менеджеры или собрать самостоятельно из дистрибутивов

Инициализация проекта

В системе необходимо завести папку проекта

mkdir course-project && cd course-project

Инициализируем проект. Вводим команду npm init и указываем базовую информацию

npm init

Система спросит несколько базовых вопросов. На этом этапе можно оставить значения по умолчанию и вернуться к ним позже

This utility will walk you through creating a package.json file.
It only covers the most common items, and tries to guess sensible defaults.

See `npm help init` for definitive documentation on these fields
and exactly what they do.

Use `npm install <pkg>` afterwards to install a package and
save it as a dependency in the package.json file.

Press ^C at any time to quit.
package name: (course-project) course-project
version: (1.0.0)
description:
entry point: (index.js)
test command:
git repository:
keywords:
author:
license: (ISC)
About to write to .../course-project/package.json:

{
  "name": "course-project",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}


Is this OK? (yes) yes

Установка плеера

Запустите команду ниже, она создаст файл .npmrc в корне проекта и добавит в него информацию, где искать нужные пакеты

echo "@htmlacademy:registry=https://npm.pkg.github.com/htmlacademy" > .npmrc

Обратите внимание, что для установки пакета потребуется токен. Для получения токена необходимо обратиться в службу поддержки

Замените _ТОКЕН_ на полученный вами токен в команде ниже и запустите ее

echo "//npm.pkg.github.com/:_authToken=_ТОКЕН_" >> .npmrc

Установите плеер в качестве npm-зависимости

npm i @htmlacademy/content-helper -DE

Добавьте скрипты в package.json для старта дев-сервера и сборки

{
    "scripts": {
        "release": "helper-cli release", // собирает релиз для публикации курса
        "start": "helper-cli watch -e dev" // запускает локальный сервер
    }
}

Создайте файл releaserc.json для конфигурации проекта

echo "{}" >> releaserc.json

Запуск плеера

Теперь если запустить npm start то поднимется дев-окружение и на локальной машине по адресу http://localhost:3000 можно посмотреть курс. Базовая настройка готова.