Skip to main content

​
Overview

@telegram-apps/create-mini-app is a CLI tool designed to scaffold your new mini application on the Telegram Mini Apps platform. It generates a project with pre-configured libraries and template files, allowing you to customize the content based on your specific requirements.

​
Usage

To run the tool, use one of the following scripts depending on your package manager.
npm
npx @telegram-apps/telegram-apps-tools@latest

​
Creating a new application

The above command executes a script that guides you through the creation of your application by sequentially prompting for the following information:

​
Project directory name

  • Prompt: Enter the name of the folder where the project files will be located.
  • Default: mini-app The script will create a subfolder with the specified name in the current directory.

​
Preferred technologies

​
TMA SDKs

  • tma.js @telegram-apps/sdk – A TypeScript library for seamless communication with Telegram Mini Apps functionality.
  • Telegram SDK @twa-dev/sdk – This package allows you to work with the SDK as an npm package.

​
Frameworks

​
Git remote repository URL

Enter the git remote repository URL. This value will be used to connect the created project with your remote git repository. It should be either an HTTPS link or an SSH connection string.

​
Build configuration

Projects created with create-mini-app are configured to use the Vite bundler. The project includes a vite.config.js file, which you can customize to adjust the build settings according to your needs.
⌘I