Workflow

Portex workflow

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

more details in Use CLI

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();

more details in Portex SDK

5. Publish your mini-game

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