Onpoint_mpa_boilerplate_2004 NPM

MPA-template

зачем

Проект создается для объединения бест-практикс в компании ONPOINT, для упрощения создания и сборки проектов, а так же унификации видов реализации бизнес-логики, такой как Router

что внутри

на данный момент проект включает в себя:

template для старта проекта
gulp-builder пакет сборки
mpa-router пакет всех роутеров

структура проекта

project
├── README.md
├── node_modules
├── package.json
├── .gitignore
├── pres_config
└── app
    ├── libs
    ├── slides
    ├── blocks
        ├── Animate
        ├── fonts
        ├── refs
        ├── Router
        └── layout
    └── components
        ├── components
        └── Router

использования шаблона

первым шагом требуется заполнить поля в файле configuration.js, такие как: клиент, платформа, наличие шареда (для вивы, для остальных false)

слайды верстаются в app/slides/

все глобальные элементы должны быть переписаны на Preact и добавлены в app/components/

при отсутствие времени глобальные элементы должны быть перенесены в папку app/blocks/global/ и уже оттуда использоваться

миксины используемые на слайдах, должны находиться в папке app/blocks/mixins/

в pres_config/ описываются сценарии

при запуске визита, собираются все презентации экспортирумые в pres_config/index.js

архивы собираются для всех презентаций экспортирумые в pres_config/index.js

csv файлы собираются для всех презентаций экспортирумые в pres_config/index.js

сборщик

сборкой проекта происходит с помощью gulp, все таски, которого описаны в пакете @onpoint-dev/gulp-builder

если возникают проблемы с его установкой возможно стоит добавить personal access token для этого требуется выполнить следующие действия: 1. https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line 2. выполнить npm login --scope=@onpoint-dev --registry=https://npm.pkg.github.com

Username: USERNAME
Password: GITHUB_ACCES_TOKEN 
Email: PUBLIC-EMAIL-ADDRESS

таски

на данный момент пакет пакет включает следующие таски:

├── default
├── screens
├── visit
├── zip
├── csv
├── csvdev
├── fullbuild
├── dist
└── buildVisit

default - собирает папку dist, используется для сборки всех слайдов, глобальных элементов,

screens - делает скрины для всех слайдов в папке dist, так же все скрины будут лежать в папке app/previews/

visit - собирает презентацию по сценариям описанным в pres_config, под платформу указанную в configuration

csvdev - собирает CSV файл для всех презентаций указанных в pres_config/index.js для нашей песочницы

csv - собирает CSV файл для всех презентаций указанных в pres_config/index.js по правилам, указанным в configuration.js

fullbuild - проводит полную сборку проекта, которая включает в себе сборку диста, скрины, визиты, зипы

dist - собирает папку dist без сервера

buildVisit - собирает папку visit без сервер

Роутер

Роутер сначала смотрит ребро для слайда, если ребра нет то:

вперед - идет по ветке
назад - идет по истории

Ссылки на readme самых распространенных заказчиков Onpoint:

veropharm - https://bitbucket.org/onpoint_dev/readme_veropharm
stada - https://bitbucket.org/onpoint_dev/readme_stada
petrovax - https://bitbucket.org/onpoint_dev/readme_petrovax
MSD!: 1) Общая информация по презам, как заливать/обновлять/config - https://bitbucket.org/onpoint_dev/readme_veeva_upload/src/master/msd/README.md 2) Общая информация по письма/хостинг MSD - https://bitbucket.org/onpoint_dev/readme_msd/src/92ae7efddb728fc8ab090bbbe5b71afbaaf1469c/email/README.md 3) Важный гайд MSD(Письма и CLM)! - https://docs.google.com/document/d/1qsvqz6FqHf8UtR0-Cv58Ycqens0GaHuuyR5a6qYs4P4/edit
платформа ct_mobile (JJ и Bayer) - https://bitbucket.org/onpoint_dev/readme_ct_mobile