npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

savant-cli

v0.0.13

Published

Savant Solutions API client

Downloads

10

Readme

Интерфейс командной строки платформы Savant

Данная утилита предназначена для помощи в разработки порталов электронного обучения на платформе Savant.

Для начала работы Вам необходимо:

  • иметь рабочий портал в системе Savant
  • установить Node.js, Git
  • уметь пользоваться терминалом Unix (в Windows можно использовать Git Bash)

Установка

Установите следующие утилиты:

npm install -g savant-cli
npm install -g grunt-cli

Создание проекта портала

Создайте директорию, в которой будут храниться файлы портала. Работа со всеми командами осуществляется из этой директории, ее мы будем называть корневой директорией проекта или просто проектом.

В корне проекта выполните:

savant init

Укажите значения следующих переменных (их можно найти на странице http://<адрес_портала>/mgmt/settings).

  • Realm ID
  • Realm Host
  • Realm Public Key
  • Realm Private Key

Для указания последних двух значений необходимо создать криптографическую пару ключей на странице настройки портала.

По окончании работы программы выполните:

npm install

В результате будут загружены и установлены программные модули, с помощью которых можно осуществлять сборку страниц, а также темы оформления портала (об этом позже).

Контроль версий

Большинство проектов следует разрабатывать под управлением системы контроля версий.

Предлагаем следующую последовательность действий для использования Git:

  1. инициализируем репозиторий: git init

  2. добавляем файл .gitignore

    .idea/
    node_modules/
    *.iml
  3. добавляем все файлы под контроль версий git add -A

  4. коммитим git commit -a -m "Initial"

  5. размещаем на Bitbucket или GitHub

Сборка темы

Сборка темы осуществляется локально с помощью Grunt и Stylus. Конфигурация сборки создается автоматически в процессе инициализации проекта.

Если, по какой-либо причине, у Вас нет файла конфигурации сборки Gruntfile.js, Вы можете взять шаблон templates/Gruntfile.js из данного репозитория и самостоятельно отредактировать его.

Процедура сборки темы такова.

  1. Запустите savant theme в корне проекта. При этом из Savant загружаются файлы Stylus, содержащие компоненты для сборки темы.

  2. В файле themes/variables.styl Вы можете переопределить различные переменные, которые влияют на отображение (например, типографику, цвета и прочие характеристики). Полный список переменных можно посмотреть в файле themes/lib/variables.styl.

  3. Необходимые стили можно добавить в файл themes.styl. При этом рекомендуется писать правила в отдельных модулях (как для организации, так и для предотвращения проблем с обновлениями), а затем включать их в themes.styl с помощью @include.

  4. В случае необходимости (например, после выхода новой версии Savant) можно загрузить обновления с Savant с помощью savant theme [file], где file -- путь к файлу, который необходимо обновить. Можно также запустить savant theme --force, в этом случае все файлы будут перезаписаны (прежде чем так делать, необходимо скоммитить текущую работу).

Создание страниц

Этот раздел появится немного позднее. Спасибо за терпение!