Portex
Portex Docs
Portex Docs
  • Getting Started
    • Introduction
    • Workflow
    • ShowCase
    • FAQs
  • CLI
    • Overview
    • New Mini-app
    • Check Mini-app
    • Deploy Mini-app
    • Publish Mini-app
    • Bot Manager
      • Bind Telegram Bot
      • Get Bot Info
      • Bot Menu
        • Set Menu Button
      • Bot Message
        • List Messages
        • Save Message
        • Delete Message
  • SDK
    • Overview
    • Friend Referral
    • Payment
    • Leaderboard
    • Webapp Adapter
Powered by GitBook
On this page
  • 1. Deploy a mini-game for testing
  • 2. Create a bot in Telegram
  • 3. Configure bot in Portex
  • 4. Integrate Portex SDK to your mini-game
  • 5. Publish your mini-game
  1. Getting Started

Workflow

PreviousIntroductionNextShowCase

Last updated 1 month ago

1. Deploy a mini-game for testing

  • install portex cli

npm install -g @portex-app/cli
  • run portex new to create a new mini-game

  • run portex deploy to deploy a mini-game for testing

2. Create a bot in Telegram

  • open telegram and search @BotFather

  • start /newbot in chat

  • set a name for your bot

  • get the bot token

3. Configure bot in Portex

  • use portex bot to configure bot

  • run portex bot register <app-name> <bot-token> to register bot

4. Integrate Portex SDK to your mini-game

  • import https://sdk.portex.app/portex-sdk.min.js to your mini-game

  • you can run portex ls to list all your mini-games with app-id

  • initialize Portex SDK with your app-id

const portex = new Portex({
  appId: 'your-app-id',
});

const result = await sdk.init();

5. Publish your mini-game

  • run portex publish to publish your mini-game for production

more details in

more details in

Use CLI
Portex SDK
Portex workflow