Skip to content

Commit

Permalink
Merge pull request #248 from Telegram-Mini-Apps/feature/scaffold-cli
Browse files Browse the repository at this point in the history
@tma.js/create-mini-app docs
  • Loading branch information
heyqbnk authored Mar 8, 2024
2 parents 0a5119a + 92c43ed commit 1ca4822
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 0 deletions.
7 changes: 7 additions & 0 deletions apps/docs/.vitepress/packages.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ export const packagesNavItem = {

export const packagesSidebar = {
[prefixed('/')]: [
{
text: 'CLI',
items: [
{ text: '@tma.js/create-mini-app', link: prefixed('/tma-js-create-mini-app') },
]
},

{
text: 'TypeScript',
items: [
Expand Down
34 changes: 34 additions & 0 deletions apps/docs/packages/tma-js-create-mini-app.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# @tma.js/create-mini-app

<p style="display: inline-flex; gap: 8px">
<a href="https://npmjs.com/package/@tma.js/create-mini-app">
<img src="https://img.shields.io/npm/v/@tma.js/create-mini-app?logo=npm"/>
</a>
<a href="https://github.com/Telegram-Mini-Apps/tma.js/tree/master/packages/create-mini-app">
<img src="https://img.shields.io/badge/source-black?logo=github"/>
</a>
</p>

CLI tool to scaffold your new mini application on the Telegram Mini Apps platform.

## Usage

To run the tool, use one of the following scripts depending on your package manager.

::: code-group
```bash [pnpm]
pnpm dlx @tma.js/create-mini-app
```

```bash [npm]
npx @tma.js/create-mini-app
```

```bash [yarn]
yarn create @tma.js/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.
38 changes: 38 additions & 0 deletions packages/create-mini-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# @tma.js/create-mini-app

[code-badge]: https://img.shields.io/badge/source-black?logo=github

[docs-badge]: https://img.shields.io/badge/documentation-blue?logo=gitbook&logoColor=white

[sdk-code-link]: https://github.com/Telegram-Mini-Apps/tma.js/tree/master/packages/create-mini-app

[sdk-docs-link]: https://docs.telegram-mini-apps.com/packages/tma-js-create-mini-app

[sdk-npm-link]: https://npmjs.com/package/@tma.js/create-mini-app

[sdk-npm-badge]: https://img.shields.io/npm/v/@tma.js/create-mini-app?logo=npm

[![NPM][sdk-npm-badge]][sdk-npm-link]
[![docs-badge]][sdk-docs-link]
[![code-badge]][sdk-code-link]

CLI tool to scaffold your new mini application on the Telegram Mini Apps platform.

## Usage

To run the tool, use one of the following scripts depending on your package manager.

```bash
# npm
npx @tma.js/create-mini-app

# yarn
yarn create @tma.js/mini-app

# pnpm
pnpm dlx @tma.js/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.

0 comments on commit 1ca4822

Please sign in to comment.