Onescript Web Vue

Это шаблон проекта для разработки web приложения, который сэкономит вам время и позволит быстро начать разработку полноценного spa web приложения.

Используется вот такой стек:

• Onescript Web
• Vue.js
• Quasar framework только UI

Необходимые инструкции:

• Документация Onescript
• Документация Onescript Web
• Статья по разработке на Onescript.Web
• Документация Vue.js
• Видеокурс по Vue.js
• Документация Quasar framework

Необходимые знания:

• Onescript
• HTML
• CSS (SCSS)
• JavaScript - достаточно основ
• Понимание работы web технологий
• Понимание работы паттерна MVC

Установка

Для начала разработки на вашем устройстве обязательно должны быть установлены:

• Visual Studio Code
• Node js
• Onescript
• Onescript Web - просто распакуйте в любую папку

Создание проекта и установка зависимостей

1. Скачиваем архив исходников данного репозитория и распаковываем его в папку проекта
2. Открываем эту папку в Visual Studio Code и открываем терминал
3. Устанавливаем все зависимости node js

npm install

4. Переходим в папку src

cd src

5. Устанавливаем все зависисмости onescript

opm install --local

6. Возвращаемся в корневую папку

cd ../

7. Открываем файл package-lock.json и меняем в нём название проекта (только маленькие буквы без пробелов). "my-web-project" меняем на имя вашего проекта

{
  "name": "my-web-project",
  "version": "0.1.0",
  "lockfileVersion": 2,
  "requires": true,
  "packages": {
    "": {
      "name": "my-web-project",
      "version": "0.1.0",

8. Открываем файл package.json и меняем в нём название проекта (только маленькие буквы без пробелов). "my-web-project" меняем на имя вашего проекта

{
  "name": "my-web-project",
  "version": "0.1.0",
  "private": true,

9. Возвращаемся к терминалу и вводим команду для обновления файлов клиентского приложения (данная команда перекомпилирует статические файлы в /src/wwwroot)

npm run dev

Запуск и отладка

Запуск и отладка сервера будет происходить на стороне onescript web. Для того, чтобы это работало, нужно создать конфигурацию файла отладки.

1. В Visual Studio Code откываем представление "Запуск и отладка"
2. Создаём файл конфигурации Onescript.Web
3. Редактируем файл launch.json в папке .vscode:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Отладка",
            "type": "oscript.web",
            "request": "launch",
            "appDir": "${workspaceRoot}\\src", - вот тут незабудьте добавить \\src
            "env": {},
            "runtimeExecutable": "<Путь к папке oscript web>\\OneScript.WebHost.exe",
            "runtimeArgs": [],
            "debugPort": 2801
        }
    ]
}

Далее для запуска нам потребуется только нажать F5

При запуске сервер проведет проверку кода и запустит сервер на порту 5000 и приложение будет доступно по адресу http://localhost:5000/

Разработка

При разработке клиентской части приложения необязательно перезагружать сервер onescript web, достаточно будет выполнить перекомпиляцию с помощью npm run dev. Соответственно, если вы сделали изменения на серверной части, достаточно будет перезапустить отладку.

Рекомендации для написания контроллеров

Вот шаблон, по которому следует разрабатывать контроллеры:

ДанныеДляОтправки = Неопределено;
КодСостояния = 200;

Попытка
	//<Тут делаем логику контроллера, меняем код состояния и устанавливаем данные для отправки, 
  //      не стесняемся генерировать исключение, т.к 
  //      метод "ПодготовитьОшибку" позаботится о возврате ошибки на клиент>
Исключение
	Возврат ОбработчикЗапросов.ПодготовитьОшибку(ИнформацияОбОшибке());
КонецПопытки;	

Возврат ОбработчикЗапросов.ПодготовитьОтвет(КодСостояния, ДанныеДляОтправки);

Вы можете вести разработку так, как удобно вам, я лишь даю рекомендации.

Итог

После всех действий вы получите шаблонный проект, который позволит вам без особых сложностей разрабатывать любое spa web приложение.