{"id":21929931,"url":"https://github.com/yamlengineer/teleplate","last_synced_at":"2025-04-19T18:52:31.451Z","repository":{"id":197440483,"uuid":"686742665","full_name":"YamlEngineer/TelePlate","owner":"YamlEngineer","description":"Telegram Bot Template with Grammy \u0026 Hono","archived":false,"fork":false,"pushed_at":"2024-11-28T14:24:14.000Z","size":15,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-28T15:30:57.816Z","etag":null,"topics":["bot-template","grammy","grammyjs","hono","honojs","telegram","telegram-bot-template"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/YamlEngineer.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":"2023-09-03T19:43:43.000Z","updated_at":"2024-11-28T14:28:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"1ff1b755-cc46-451a-b4dc-fe5bb8cec371","html_url":"https://github.com/YamlEngineer/TelePlate","commit_stats":null,"previous_names":["yamlengineer/teleplate"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YamlEngineer%2FTelePlate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YamlEngineer%2FTelePlate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YamlEngineer%2FTelePlate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/YamlEngineer%2FTelePlate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/YamlEngineer","download_url":"https://codeload.github.com/YamlEngineer/TelePlate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227003789,"owners_count":17715748,"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":["bot-template","grammy","grammyjs","hono","honojs","telegram","telegram-bot-template"],"created_at":"2024-11-28T23:06:17.753Z","updated_at":"2025-04-19T18:52:31.444Z","avatar_url":"https://github.com/YamlEngineer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e🤖 Teleplate\u003c/h1\u003e\n\nBot starter template based on [grammY](https://grammy.dev/) bot framework.\n\n## Features\n\n- Scalable structure\n- Config loading and validation\n- Internationalization, language changing\n- Graceful shutdown\n- Logger (powered by [pino](https://github.com/pinojs/pino))\n- Ultrafast and multi-runtime server (powered by [hono](https://github.com/honojs/hono))\n\n## Usage\n\nFollow these steps to set up and run your bot using this template:\n\n1. **Create a New Repository**\n\n    Start by creating a new repository using this template. You can do this by clicking [here](https://github.com/yamlengineer/teleplate/generate).\n\n2. **Environment Variables Setup**\n\n    Create an environment variables file by copying the provided example file:\n     ```bash\n     cp .env.example .env\n     ```\n    Open the newly created `.env` file and set the `BOT_TOKEN` environment variable.\n\n3. **Launching the Bot**\n\n    You can run your bot in both development and production modes.\n\n    **Development Mode:**\n\n    Install the required dependencies:\n    ```bash\n    bun install\n    ```\n    Start the bot in watch mode (auto-reload when code changes):\n    ```bash\n    bun run dev\n    ```\n\n   **Production Mode:**\n\n    Install only production dependencies:\n    ```bash\n    bun install --only=prod\n    ```\n\n    Set `DEBUG` environment variable to `false` in your `.env` file.\n\n    Start the bot in production mode:\n    ```bash\n    bun run start:force # skip type checking and start\n    # or\n    bun start # with type checking (requires development dependencies)\n    ```\n\n### List of Available Commands\n\n- `bun run dev` — Start the bot in development mode.\n\n### Directory Structure\n\n```\nproject-root/\n  ├── locales                         # Localization files\n  └── src                             # Codes\n      ├── common                      # Common Files like Custom Context\n      ├── helpers                     # Helper functions\n      ├── middlewares                 # Bot middlewares\n      ├── modules                     # bot Modules\n      │   ├── example                 # Module Name\n      │   │   ├── example.module.ts   # Get updates\n      │   │   └── example.service.ts  # Answer updates \n      │   ├── somthing                # other modules\n      ├── bootstrap.ts                # bot entry point\n      └── index.ts                    # Application entry point\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamlengineer%2Fteleplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyamlengineer%2Fteleplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyamlengineer%2Fteleplate/lists"}