{"id":16370308,"url":"https://github.com/deptyped/notepher-bot","last_synced_at":"2026-02-26T06:55:03.908Z","repository":{"id":199575199,"uuid":"703091766","full_name":"deptyped/notepher-bot","owner":"deptyped","description":"Note-taking Telegram Mini App","archived":false,"fork":false,"pushed_at":"2024-03-12T20:39:17.000Z","size":620,"stargazers_count":179,"open_issues_count":5,"forks_count":29,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-12-31T10:14:45.460Z","etag":null,"topics":["telegram","telegram-bot","telegram-mini-app","telegram-miniapp-contest-2023","telegram-web-app"],"latest_commit_sha":null,"homepage":"https://t.me/NotepherBot","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deptyped.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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-10-10T15:21:33.000Z","updated_at":"2024-12-28T13:48:47.000Z","dependencies_parsed_at":"2023-10-11T02:30:00.377Z","dependency_job_id":"873226cf-9309-4daa-8b80-026621517597","html_url":"https://github.com/deptyped/notepher-bot","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"35f850c7d44127145175596e457e4776e334a6bd"},"previous_names":["deptyped/notepher-bot"],"tags_count":0,"template":false,"template_full_name":"bot-base/telegram-bot-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deptyped%2Fnotepher-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deptyped%2Fnotepher-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deptyped%2Fnotepher-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deptyped%2Fnotepher-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deptyped","download_url":"https://codeload.github.com/deptyped/notepher-bot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239887940,"owners_count":19713681,"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":["telegram","telegram-bot","telegram-mini-app","telegram-miniapp-contest-2023","telegram-web-app"],"created_at":"2024-10-11T03:04:41.355Z","updated_at":"2026-02-26T06:55:03.853Z","avatar_url":"https://github.com/deptyped.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003ca href=\"https://t.me/NotepherBot\"\u003e\n    \u003cdiv align=\"center\"\u003e\n      \u003cimg src=\"./assets/logo.png\"\u003e\n    \u003c/div\u003e\n    \u003cspan\u003e\n      Notepher Bot\n    \u003c/span\u003e\n  \u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cimg align=\"right\" width=\"40%\" src=\"./assets/header.png\"\u003e\n\n[Notepher](https://t.me/NotepherBot) is an intuitive note-taking [Telegram Mini App](https://core.telegram.org/bots/webapps) designed to effortlessly capture your ideas, to-do lists, and important information. Stay organized and productive without leaving your favorite messenger. \n\n## Features\n\n- **Offline First**. Notes are stored locally and synchronized when an internet connection is available.\n- **Synced**. Notepher leverages the power of [Telegram Cloud Storage](https://core.telegram.org/bots/webapps#cloudstorage) to keep your notes in sync across all your devices.\n- **Seamless**. Interface colors match your app theme.\n- **Organized**. Tag your notes and filter them by tags, pin the most important notes at the top.\n- **Search**. Instantly search through all your notes.\n- **Powerful**. Formatting, text highlighting, editing history, lists and to-do lists.\n\nFor more details, check out [User Guide](./README_USER.md).\n\n## Launch\n\nFollow these steps to set up and run your bot using this repository:\n\n1. **Clone Repository**\n\n    ```bash\n    git clone https://github.com/deptyped/notepher-bot.git\n    ```\n\n2. **Build and Deploy Web App**\n\n    After cloning the repository, navigate to the `web-app` directory:\n\n    ```bash\n    cd apps/web-app\n    ```\n\n    Run the following command to build the web app:\n    ```bash\n    npm run build\n    ```\n\n    This command will generate build output resources inside the `dist` directory. You can now deploy these resources as a regular static website to your hosting provider of choice.\n\n    For information on launching the web app in developer mode, please refer to [apps/web-app/README.md](./apps/web-app/README.md)\n\n3. **Configure the Menu Button**\n\n    - Open the Telegram app and search for \"[@BotFather](https://t.me/BotFather)\".\n    - Start a chat with [@BotFather](https://t.me/BotFather).\n    - Use the `/setmenubutton` command to see your bot list and select the bot you want to configure the menu button.\n    - Follow the prompts to set up the menu button with the URL obtained in the previous step.\n    - After that, the menu button will be available to users when they interact with your bot.\n\n  **Congrats!** Web App is deployed and available to bot users.\n\n\u003e [!NOTE]\n\u003e At this stage web app is fully functional, further steps are optional.\n\n4. **Environment Variables Setup**\n    \n    Once you have completed the web app build and deployment, navigate to the `apps/bot` directory:\n\n    ```bash\n    cd ../bot\n    ```\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. This token should be obtained from [@BotFather](https://t.me/BotFather). \n\n    Set the `WEB_APP_URL` environment variable with the URL obtained during the web app deployment (step 2).\n\n5. **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    npm install\n    ```\n    Start the bot in watch mode (auto-reload when code changes):\n    ```bash\n    npm run dev\n    ```\n\n   **Production Mode:**\n    \n    Install only production dependencies (no development dependencies):\n    ```bash\n    npm install --only=prod\n    ```\n    \n    Set the `NODE_ENV` environment variable to \"production\" in your `.env` file. Also, make sure to update `BOT_WEBHOOK` with the actual URL where your bot will receive updates.\n    ```dotenv\n    NODE_ENV=production\n    BOT_WEBHOOK=\u003cyour_webhook_url\u003e\n    ```\n    \n    Start the bot in production mode:\n    ```bash\n    npm start\n    # or\n    npm run start:force # if you want to skip type checking\n    ```\n\n### List of Available Commands\n\n- `npm run lint` — Lint source code.\n- `npm run format` — Format source code.\n- `npm run typecheck` — Run type checking.\n- `npm run dev` — Start the bot in development mode.\n- `npm run start` — Start the bot.\n- `npm run start:force` — Start the bot without type checking.\n\n## Environment Variables\n\n\u003ctable\u003e\n\u003cthead\u003e\n  \u003ctr\u003e\n    \u003cth\u003eVariable\u003c/th\u003e\n    \u003cth\u003eType\u003c/th\u003e\n    \u003cth\u003eDescription\u003c/th\u003e\n  \u003c/tr\u003e\n\u003c/thead\u003e\n\u003ctbody\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eNODE_ENV\u003c/td\u003e\n    \u003ctd\u003eString\u003c/td\u003e\n    \u003ctd\u003eSpecifies the application environment. (\u003ccode\u003edevelopment\u003c/code\u003e or \u003ccode\u003eproduction\u003c/code\u003e)\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_TOKEN\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        Telegram Bot API token obtained from \u003ca href=\"https://t.me/BotFather\"\u003e@BotFather\u003c/a\u003e.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eWEB_APP_URL\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        HTTPS link to Web App.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n    \u003ctr\u003e\n    \u003ctd\u003eLOG_LEVEL\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e\n        Specifies the application log level. \u003cbr/\u003e\n        For example, use \u003ccode\u003einfo\u003c/code\u003e for general logging. View the \u003ca href=\"https://github.com/pinojs/pino/blob/master/docs/api.md#level-string\"\u003ePino documentation\u003c/a\u003e for more log level options. \u003cbr/\u003e\n        Defaults to \u003ccode\u003einfo\u003c/code\u003e.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_MODE\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e\n        Specifies method to receive incoming updates. (\u003ccode\u003epolling\u003c/code\u003e or \u003ccode\u003ewebhook\u003c/code\u003e)\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_WEBHOOK\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional in \u003ccode\u003epolling\u003c/code\u003e mode.\u003c/i\u003e\n        Webhook endpoint URL, used to configure webhook in \u003cb\u003eproduction\u003c/b\u003e environment.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_SERVER_HOST\u003c/td\u003e\n    \u003ctd\u003e\n        String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e Specifies the server hostname. \u003cbr/\u003e\n        Defaults to \u003ccode\u003e0.0.0.0\u003c/code\u003e.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_SERVER_PORT\u003c/td\u003e\n    \u003ctd\u003e\n        Number\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e Specifies the server port. \u003cbr/\u003e\n        Defaults to \u003ccode\u003e80\u003c/code\u003e.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_ALLOWED_UPDATES\u003c/td\u003e\n    \u003ctd\u003e\n        Array of String\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e A JSON-serialized list of the update types you want your bot to receive. See \u003ca href=\"https://core.telegram.org/bots/api#update\"\u003eUpdate\u003c/a\u003e for a complete list of available update types. \u003cbr/\u003e\n        Defaults to an empty array (all update types except \u003ccode\u003echat_member\u003c/code\u003e).\n    \u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eBOT_ADMINS\u003c/td\u003e\n    \u003ctd\u003e\n        Array of Number\n    \u003c/td\u003e\n    \u003ctd\u003e\n        \u003ci\u003eOptional.\u003c/i\u003e \n        Administrator user IDs. \n        Use this to specify user IDs that have special privileges, such as executing \u003ccode\u003e/setcommands\u003c/code\u003e. \u003cbr/\u003e\n        Defaults to an empty array.\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/tbody\u003e\n\u003c/table\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeptyped%2Fnotepher-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeptyped%2Fnotepher-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeptyped%2Fnotepher-bot/lists"}