@vkontakte/create-vk-mini-app

Create VK Mini App

How to use

With NPX

npx @vkontakte/create-vk-mini-app@latest [app-directory-name] [options]

NPX allows you to always use the latest version of the package without a global installation.

With installing the package globally

Install the package globally via yarn

yarn global add @vkontakte/create-vk-mini-app

...or npm

npm install --global @vkontakte/create-vk-mini-app

and use as follows

create-vk-mini-app [app-directory-name] [options]

This way is less recommended because you will have to update the package yourself.

Options

Without --zeit and --surge options

--zeit

Vercel (Zeit) deploy

Firstly, you have to create Vercel account and connect it with your GitHub profile on vercel.com

--surge <surge-domain>

Surge deploy

Firstly, you have to create Surge account and Surge-domain on surge.sh

--template <templat-type>

Build with specific template (typescript or javascript)

--help

Prints the synopsis and a list of options

How to start work with app

Go to created folder and run: yarn start or npm start to start dev server with hot reload on localhost:10888.

yarn run build or npm run build to build production bundle, with tree-shaking, uglify and all this modern fancy stuff.