A modern CLI tool for creating and managing Telegram Mini Apps with Vue.js and FastAPI.
PyVueBot streamlines the development of Telegram Mini Apps by providing:
- Project scaffolding from templates with variable substitution
- Interactive setup wizard for easy configuration
- Development server with hot reloading
- Production builds and deployment
- Integrated Telegram webhook management
- Vercel deployment support
pip install pyvuebot- Create a new project:
pyvuebot init my-telegram-app- Install dependencies:
cd my-telegram-app
pyvuebot install- Start development:
pyvuebot dev- Configure your webhook:
pyvuebot webhook set- Build and deploy:
pyvuebot build
pyvuebot deploy-
pyvuebot init [NAME]- Create a new project--template- Specify a template (default: task_manager)--description- Project description--yes, -y- Skip interactive prompts and use defaults--force, -f- Override existing directory
-
pyvuebot install- Install dependencies -
pyvuebot dev- Start development servers -
pyvuebot build- Build for production -
pyvuebot deploy- Deploy to Vercel
-
pyvuebot webhook set- Set up a Telegram bot webhook--token- Telegram bot token--url- Web app URL--path- Custom webhook path
-
pyvuebot webhook info- Check webhook status--token- Telegram bot token
-
pyvuebot webhook delete- Delete webhook--token- Telegram bot token--drop-pending- Drop pending updates
Currently available templates:
task_manager- Full-stack task management app (default)- More coming soon...
my-telegram-app/
├── api/ # FastAPI backend
│ ├── routes/ # API endpoints
│ ├── models.py # Data models
│ └── db.py # Database setup
├── src/ # Vue.js frontend
│ ├── components/ # Vue components
│ ├── services/ # API services
│ └── store/ # State management
├── index.html # HTML entry point
├── package.json # Node dependencies
├── requirements.txt # Python dependencies
├── .env # Environment variables
├── .env.example # Environment variables template
├── vercel.json # Vercel configuration
└── pyvuebot.json # Project configuration
The pyvuebot.json file contains project configuration:
{
"name": "my-telegram-app",
"template": "task_manager",
"description": "My Telegram Mini App",
"version": "0.1.0",
"created_at": "2023-03-31T01:53:14.539642"
}Templates can use variables in the format {{ variable_name }} which will be replaced during project creation:
{{ project_name }}- Project name{{ project_description }}- Project description{{ creation_date }}- Creation date (YYYY-MM-DD){{ creation_year }}- Creation year{{ template_name }}- Template name
Required environment variables:
TELEGRAM_BOT_TOKEN- Your Telegram bot tokenWEB_APP_URL- URL where your app is deployedSUPABASE_URL- Supabase project URL (if using Supabase)SUPABASE_KEY- Supabase project key (if using Supabase)VITE_TELEGRAM_BOT_LINK- Link to your Telegram bot
If you find PyVueBot useful, please consider giving it a star on GitHub! Your support helps the project grow.
# Or clone and star through GitHub CLI
gh repo clone venopyx/pyvuebot
gh repo star venopyx/pyvuebotTo contribute to PyVueBot:
- Clone the repository:
git clone https://github.com/venopyx/pyvuebot.git
cd pyvuebot- Install dependencies:
poetry install- Create a new branch:
git checkout -b feature/your-feature- Make your changes and submit a pull request
MIT License - see LICENSE for details
- Gemechis Chala (@venopyx)
- Email: [email protected]
- GitHub Issues: Report bugs
- Telegram: @venopyx
- Twitter: @venopyx