diff --git a/apps/docs/packages/telegram-apps-create-mini-app.md b/apps/docs/packages/telegram-apps-create-mini-app.md index b0bed733c..bc4a541ca 100644 --- a/apps/docs/packages/telegram-apps-create-mini-app.md +++ b/apps/docs/packages/telegram-apps-create-mini-app.md @@ -9,7 +9,9 @@

-CLI tool to scaffold your new mini application on the Telegram Mini Apps platform. +`@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 @@ -29,6 +31,32 @@ yarn create @telegram-apps/mini-app ``` ::: -The tool will launch the project initialization process, prompting you with questions related to the -required technologies for your project and ultimately creating your project using some well-known -templates. \ No newline at end of file +## 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: + +### 1. 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. + +### 2. Preferred Technologies + +| Option | Details | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Language** | Choose between **TypeScript** or **JavaScript**. | +| **SDK Selection** | **• tma.js** [@telegram-apps/sdk](https://www.npmjs.com/package/@telegram-apps/sdk)
A TypeScript library for seamless communication with Telegram Mini Apps functionality.
**• Telegram SDK** [@twa-dev/sdk](https://www.npmjs.com/package/@twa-dev/sdk)
This package allows you to work with the SDK as an npm package. | +| **Frameworks** | **• React.js** [template](https://github.com/Telegram-Mini-Apps/reactjs-template)
**• Next.js** [template](https://github.com/Telegram-Mini-Apps/nextjs-template)
**• Solid.js** [template](https://github.com/Telegram-Mini-Apps/solidjs-js-template)
| + +### 3. Git Remote Repository URL (Optional) + +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](https://vite.dev/) bundler. The project includes a `vite.config.js` file, +which you can customize to adjust the build settings according to your needs. diff --git a/packages/create-mini-app/README.md b/packages/create-mini-app/README.md index fdfa2c309..34cd1b260 100644 --- a/packages/create-mini-app/README.md +++ b/packages/create-mini-app/README.md @@ -16,7 +16,8 @@ [![docs-badge]][docs-link] [![code-badge]][code-link] -CLI tool to scaffold your new mini application on the Telegram Mini Apps platform. +`@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 @@ -33,6 +34,32 @@ yarn create @telegram-apps/mini-app pnpm dlx @telegram-apps/create-mini-app ``` -The tool will launch the project initialization process, prompting you with questions related to the -required technologies for your project and ultimately creating your project using some well-known -templates. \ No newline at end of file +## 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: + +### 1. 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. + +### 2. Preferred Technologies + +| Option | Details | +|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Language** | Choose between **TypeScript** or **JavaScript**. | +| **SDK Selection** | **• tma.js** [@telegram-apps/sdk](https://www.npmjs.com/package/@telegram-apps/sdk)
A TypeScript library for seamless communication with Telegram Mini Apps functionality.
**• Telegram SDK** [@twa-dev/sdk](https://www.npmjs.com/package/@twa-dev/sdk)
This package allows you to work with the SDK as an npm package. | +| **Frameworks** | **• React.js** [template](https://github.com/Telegram-Mini-Apps/reactjs-template)
**• Next.js** [template](https://github.com/Telegram-Mini-Apps/nextjs-template)
**• Solid.js** [template](https://github.com/Telegram-Mini-Apps/solidjs-js-template)
| + +### 3. Git Remote Repository URL (Optional) + +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.