Module console

Консольный скрипт

Назначение

Скрипт предназначен для быстрого создания приложения. Он способен создать шаблон приложения.

Использование

Чтобы воспользоваться скриптом, запустите файл umbot.js, и передайте необходимые параметры.

npm umbot

Команды

На данный момент поддерживаются 1 команда:

  • create - Создать проект

При создании проекта, в качестве 2 параметра нужно передать либо название проекта на английском языке, либо json файл с конфигурацией. При передаче json файла, можно создать шаблон приложения определенного типа. Сейчас поддерживается quiz - викторина, и пустой проект.

Пример json файла

{
"name": "Название проекта (*)",
"type": "Тип проекта. default, quiz",
"mode": "Режим работы приложения. prod, dev, dev-online, build",
"config": ["Конфигурация для подключения к бд. Структуру смотри в mmApp.config"],
"params": ["Параметры приложения. Структуру смотри в mmApp.params"],
"path": "Директория, в которой будет создан проект. По умолчанию, проект создается в папке с именем проекта, в директории запуска скрипта.",
"hostname": "Имя хоста на котором будет запущено приложение. По умолчанию localhost",
"port": "Порт на котором будет запущено приложение. По умолчанию 3000"
}

'*' - обозначены обязательные поля.

Пример использования

Создание пустого проекта:

npm umbot create project

Создание проекта, используя в качестве параметра json

{
"name": "project",
"type": "quiz"
}
npm umbot create project.json

Index

Classes

Variables

Functions

Generated using TypeDoc