eduterra-cli/README.md

EduTerra API client

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

Данная утилита предназначена для работы с системами обучения на платформе [EduTerra](http://eduterra.pro).

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

  * иметь рабочий портал в системе EduTerra
  * установить [Node.js](http://nodejs.org), [Git](http://git-scm.com)
  * уметь пользоваться терминалом Unix (в Windows можно использовать Git Bash)

## Установка

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

```
npm install -g eduterra-cli grunt-cli
```

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

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

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

```
eduterra 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