{"id":18317467,"url":"https://github.com/telegram-mini-apps/mate-docs","last_synced_at":"2025-06-24T04:31:54.874Z","repository":{"id":253400665,"uuid":"843383915","full_name":"Telegram-Mini-Apps/mate-docs","owner":"Telegram-Mini-Apps","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-24T21:13:59.000Z","size":168,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-09T14:08:13.584Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Telegram-Mini-Apps.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-16T11:53:20.000Z","updated_at":"2025-03-23T07:51:02.000Z","dependencies_parsed_at":"2025-02-15T07:45:51.580Z","dependency_job_id":"e37ad195-062a-49a0-82e7-e39f9684fef6","html_url":"https://github.com/Telegram-Mini-Apps/mate-docs","commit_stats":null,"previous_names":["telegram-mini-apps/mate-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Telegram-Mini-Apps/mate-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telegram-Mini-Apps%2Fmate-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telegram-Mini-Apps%2Fmate-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telegram-Mini-Apps%2Fmate-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telegram-Mini-Apps%2Fmate-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Telegram-Mini-Apps","download_url":"https://codeload.github.com/Telegram-Mini-Apps/mate-docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Telegram-Mini-Apps%2Fmate-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261604128,"owners_count":23183596,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T18:06:12.812Z","updated_at":"2025-06-24T04:31:54.845Z","avatar_url":"https://github.com/Telegram-Mini-Apps.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Telegram Mini Apps Mate\n\nYour companion for managing Telegram Mini Apps.\n\nThis project simplifies the manipulation of your mini app distribution files.\n\n## Getting Started\n\nTo start using the project, you need to obtain your deploy token, which is unique to each project.\nTo get your token, go to [@tma_mate_bot](https://t.me/tma_mate_bot) and press the `Start` button.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./img/start.png\" width=\"320\"/\u003e\n\u003c/p\u003e\n\nNext, press the `Create a Project` button and enter the name of your project, following the\nspecified rules.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./img/create.png\" width=\"320\"/\u003e\n\u003c/p\u003e\n\nAfter this step, the bot will provide you with a `Deploy Token`, which you will use later to deploy\nthe project.\n\n### Installing @telegram-apps/mate\n\nTo deploy your project, you need to install\nthe [@telegram-apps/mate](https://www.npmjs.com/package/@telegram-apps/mate) CLI package.\n\n```bash\n# Using pnpm\npnpm i -D @telegram-apps/mate\n# or npm\nnpm i -D @telegram-apps/mate\n# or yarn\nyarn add -D @telegram-apps/mate\n```\n\nAlternatively, you can install it globally:\n\n```bash\n# Using pnpm\npnpm i -g @telegram-apps/mate\n# or npm\nnpm i -g @telegram-apps/mate\n# or yarn\nyarn global add @telegram-apps/mate\n```\n\nOnce installed, the package will be accessible via the `mate` CLI tool:\n\n```bash\nmate --help\n```\n\nNot to install the package, you can also use the package using `pnpm` or `npx`:\n\n```bash\n# Using npx\nnpx @telegram-apps/mate@latest --help\n\n# Using pnpm\npnpm dlx @telegram-apps/mate@latest --help\n```\n\n## Getting Project Deployment Info\n\nBefore deploying the project, you might want to know the base URL. The base URL is the absolute URL\nthat the project bundler will use to create links to all project assets.\n\nTo retrieve the project deployment information, including the base URL, use the following command:\n\n```bash\n# TOKEN refers to the deploy token received from the bot.\n# PROJECT is a project identifier. Example: 48\nmate deploy info --token {TOKEN} --project {PROJECT}\n```\n\nYou will see an output similar to this:\n\n```\n✔ Fetched deploy information for paper-planes (id 48) project\nProject Title: paper-planes\nShort title of the project\n--------\nBase Path (using tag \"test\"): https://35f105bd6b.tapps.global/latest\nThis path will be used as a base path for the uploaded assets associated with this project. \nConsider using this value as a base path in your bundler. You can also use different tags using \nthe --tag option\n--------\nAllowed file extensions: html, css, js, cjs, mjs, png, jpg, jpeg, webp, ttf, woff, woff2, eot, \njson, ico\nFiles extensions which are allowed to be uploaded\n--------\nMaximum size: 10485760 bytes\nMaximum upload size\n--------\nMaximum files count: 100\nMaximum files count a single upload can contain\n```\n\nThe value `https://35f105bd6b.tapps.global/latest` is the base URL that you should\nuse in your bundler.\n\n## Deploying\n\nBefore deploying the project assets, ensure that you have built your project and are not deploying\nsource files. You should only deploy files that can be successfully opened by the user's browser.\n\nLet’s assume you have a project with id `48`. Also, you have a `dist` directory with all\nthe built files. To deploy this directory to the CDN, use the following command:\n\n```bash\n# TOKEN refers to the deploy token received from the bot.\nmate deploy upload --dir dist --token {SPECIFY TOKEN HERE} --project 48\n```\n\nAs a result, you will see a message like this in your console:\n\n```\n✔ Fetched deploy information for paper-planes (id 48) project\ni Assets base path (using tag \"latest\"): https://35f105bd6b.tapps.global/latest\ni Allowed file extensions: html, css, js, cjs, mjs, png, jpg, jpeg, webp, ttf, woff, woff2, eot, \njson, ico\ni Maximum upload size: 10485760 bytes\ni Maximum files count: 100\n✔ Directory compressed successfully from 24185 to 7168 bytes\n✔ Archive uploaded successfully\n📁 dist\n╰ 📄 index.js (https://35f105bd6b.tapps.global/latest/index.js)\n```\n\n\u003e **Important**\n\u003e\n\u003e Note that your directory must include only usual files and directories.\n\u003e All other types of files (symlinks, for example) are forbidden, the CLI toll will let you know\n\u003e about it.\n\n## Tagging\n\nMate allows you to use multiple tags in your project. A tag is simply a marker for your deployment\nversion.\n\nEach tag corresponds to its own subdirectory, which is reflected in the final asset URL.\n\nBy default, Mate uses the `latest` tag. To override this, use the `--tag` option:\n\n```bash\nmate deploy upload --dir dist --token {TOKEN} --project {PROJECT} --tag test\n```\n\n## Using Config\n\nTo enhance your experience, you can create a `mate.yml` file in your project root directory and\ninclude the following content:\n\n```yml\ndeploy:\n  projectId: {PROJECT}\n  directory: dist\n  token: {TOKEN}\n```\n\nThen, you can use the `mate` commands:\n\n```bash\nmate deploy info\nmate deploy upload\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelegram-mini-apps%2Fmate-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftelegram-mini-apps%2Fmate-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftelegram-mini-apps%2Fmate-docs/lists"}