@eolme/create-vk-mini-app

Create VK Mini App

Create VK Mini App with no build configuration.

• Creating an App – How to create a new app.
• User Guide – CLI usage.

Create VK Mini App works on macOS, Windows, and Linux. If something doesn’t work, please file an issue.

Quick Overview

npx @eolme/create-vk-mini-app my-app
cd my-app
npm start

If you've previously installed @eolme/create-vk-mini-app globally via npm install -g @eolme/create-vk-mini-app, we recommend you uninstall the package using npm uninstall -g @eolme/create-vk-mini-app to ensure that npx always uses the latest version.

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

When you’re ready to deploy to production, create a minified bundle with npm run build.

Get Started Immediately

You don’t need to install or configure tools like webpack or Babel. They are preconfigured and hidden so that you can focus on the code.

Create a project, and you’re good to go.

Creating an App

You’ll need to have Node 8.16.0 or Node 10.16.0 or later version on your local development machine (but it’s not required on the server). You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.

To create a new app, you may choose one of the following methods:

npx

npx @eolme/create-vk-mini-app my-app

(npx is a package runner tool that comes with npm 5.2+ and higher, see instructions for older npm versions)

npm

npm init @eolme/vk-mini-app my-app

npm init <initializer> is available in npm 6+

Yarn

yarn create @eolme/vk-mini-app my-app

yarn create <starter-kit-package> is available in Yarn 0.25+

It will create a directory called my-app inside the current folder. Inside that directory, it will generate the initial project structure and install the transitive dependencies:

No configuration or complicated folder structures, only the files you need to build your app. Once the installation is done, you can open your project folder:

cd my-app

Inside the newly created project, you can run some built-in commands:

npm start or yarn start

Runs the app in development mode. The page will automatically reload if you make changes to the code. You will see the build errors and lint warnings in the console.

npm run build or yarn build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.

Your app is ready to be deployed.

User Guide

Usage: @eolme/create-vk-mini-app <project-directory> [options]

Options:
  -V, --version            output the version number
  --verbose                print additional logs
  --use-npm
  --deploy-zeit
  --deploy-surge <domain>
  --deploy-vk
  --typescript
  -h, --help               output usage information
    Only <project-directory> is required.

What’s Included?

• Default and typescript included templates
• Scripts for deploying on the Zeit, Surge or VK Mini Apps hosting platforms

Contributing

We'd love to have your helping hand on create-vk-mini-app! See CONTRIBUTING.md for more information on what we're looking for and how to get started.

Acknowledgements

We are grateful to the authors of original create-react-app and create-vk-mini-app for their ideas and collaboration:

• @eanplatter
• @insin
• @mxstbr
• @kuhel
• @danakt

License

Create VK Mini App is open source software licensed as MIT.