suri
v1.0.0
Необходимо хостинг на стороне сервера, без сервера облачных функций или базы данных. Статические сайты Suri могут быть развернуты в Vercel, NetLify и больше (обычно бесплатно) через несколько минут.
Сури не заботится о «технически превосходных» перенаправлениях 3xx . Сури просто хочет, чтобы вы наконец использовали этот домен, на котором вы тратите 59 долларов в год, и возвращаете свои короткие ссылки из битовых и крошечных в Интернете.
https://surishort.link/gh ⇒ https://github.com/surishortlink/suri
https://surishort.link является примером сайта, который демонстрирует Сури в действии. Вы можете проверить репозиторий для сайта и файл, который управляет ссылками, чтобы увидеть, как он работает.
У Suri есть репозитории шаблонов, которые позволяют легко начать работу. Выберите платформу, которую вы развертываете, и следуйте пошаговым инструкциям:
Не развертывание на одной из этих платформ? Не беспокойся. Вот несколько общих вариантов, которые охватывают большинство других сценариев, будь то другой облачный провайдер или разбирая его самостоятельно:
В основе Suri лежит файл links.json , расположенный в каталоге src , где вы управляете своими ссылками. Все хранилища шаблонов включают этот файл, высеченный несколькими примерами:
{
"/" : " https://www.youtube.com/watch?v=CsHiG-43Fzg " ,
"1" : " https://fee.org/articles/the-use-of-knowledge-in-society/ " ,
"gh" : " https://github.com/surishortlink/suri "
} Это не может быть проще: ключом является путь «короткая ссылка», который перенаправляется, а значение является целевым URL. Ключи могут быть так коротки или столько, сколько вы хотите, используя любую смесь символов, которые вы хотите. / это специальная запись для перенаправления корневого пути.
Suri поставляется с исполняемым файлом suri , который генерирует статический сайт из файла links.json . Статический сайт выводится в каталог с именем build .
Все репозитории шаблонов настроены с помощью сценария build , который вызывает этот исполняемый файл, что делает команду простой:
npm run build Когда вы внесете изменение в файл links.json , просто повторно запустите эту команду, чтобы повторно генерировать статический сайт, который затем может быть повторно развернуть. Многие из платформ, для которых Suri есть репозитории шаблонов, настроены для автоматического дела.
Конфигурация обрабатывается через файл suri.config.json в корневом каталоге. На данный момент есть только один вариант:
| Вариант | Описание | Тип | По умолчанию |
|---|---|---|---|
js | Перенаправить с JavaScript вместо <meta> обновить. | Логический | false |
Наконец, любые файлы в public каталоге будут скопированы в каталог build без модификации при создании статического сайта. Это может быть полезно для таких файлов, как favicon.ico или robots.txt (при этом Suri обеспечивает разумные знания по умолчанию для обоих).
Если вы ранее разделили/клонировали этот репозиторий, когда он был в версии с 0.1 по 0,5.1, вы заметите несколько различий сейчас с версией 1.
Версия 1 решает три основных вопроса с версией 0:
app.json вас все еще был render.yaml . V1 исправляет это, имея отдельные репозитории шаблонов для каждой платформы, которая включает только необходимые файлы для этой платформы. Итак, как вы обновляетесь? Если вы только когда -либо отредактировали свой файл links.json .
links.json .public каталоге, скопируйте их.SURI_JS на 1 , измените js на true в suri.config.json . Если вы отредактировали любой из десятилетия файлов - например, шаблон links.njk - вы, вероятно, просто хотите придерживаться V0 и продолжать использовать один из них.
Есть несколько других примечательных изменений в V1 за пределами этого:
build вместо _site .suri.config.json вместо переменных среды.npm run clean чтобы удалить каталог сборки. npm run build делает это автоматически перед каждой новой сборкой. В противном случае вы можете вручную добавить его обратно, если вы нашли это полезным.npm run dev для строительства, наблюдения и обслуживания статического сайта во время разработки. Это излишне для крошечной HTML -страницы, которую генерирует Сури.npm run lint в Lint с красивым. Вы можете вручную добавить его обратно, если найдете это полезным.npm run release чтобы выпустить новую версию Suri. Вы можете вручную добавить его обратно, если вы хотите отметить версии выпуска вашего репозитория.jstayton на GitHub в новую организацию surishortlink для всех репозитории, связанных с SURI. Единственным предпосылкой является совместимая версия node.js (см. engines.node in package.json ).
Установите зависимости с NPM:
npm installДля тестирования используется встроенный тестовый бегун Node.js и модуль утверждений.
Чтобы запустить тесты:
npm testВо время разработки рекомендуется автоматически запустить тесты при изменении файла:
npm test -- --watchJSDOC используется для документирования кода.
Чтобы сгенерировать документы как HTML в каталог docs (GIT-подпись:
npm run docsProttier настроена на обеспечение согласованного стиля кода. Настоятельно рекомендуется добавить интеграцию в ваш редактор, которая автоматически форматирует при сохранении.
Eslint настроена с «рекомендуемыми» правилами для обеспечения соблюдения уровня качества кода. Также настоятельно рекомендуется добавить интеграцию в ваш редактор, которая автоматически форматирует при сохранении.
Запустить через командную строку:
npm run lint Когда филиал development готов к выпуску, выпустите его! используется для организации процесса освобождения:
npm run release После завершения процесса выпуска объедините ветвь development в main ветвь, которая всегда должна отражать последний выпуск.
