Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 3.92 KB

README.md

File metadata and controls

62 lines (40 loc) · 3.92 KB


Mobile client of Remark (AI-powered bookmark manager) based on telegram messanger. Have the same functionality.

This project is aimed to make Remark even more better allowing creating bookmarks across platforms. Because this project has the same functionality it means we need to deploy remark-aws-backend first and then use provided api information to setup this telegram bot. Due to this, remark-telegram-bot is not common available bot, it means we also need to deploy this bot before using with unique TOKEN gathered from Telegram API program.

Deploy

This Bot is AWS-based and you can deploy it with one command in your terminal. But before you need to create your own telegram bot. Follow those instructions and save TOKEN in safe place, we will use it.

Also we need to configure our Amazon profiles to allow deploying to AWS. The instructions are pretty the same as for remark-aws-backend.

npx -p @vtcaregorodtcev/remark-telegram-bot -c "TOKEN=your_token npm run deploy"

After running this command you should be allowed to set up API config and start creating bookmarks just by dropping messages with links to your deployed bot.

But if there some issue and BOT will not respond you can try to set up it mannualy. For this you need to get path of your deployed bot in SMM Parameters Store

Just go to this parameter and get it's value. After that run following command.

npx -p @vtcaregorodtcev/remark-telegram-bot -c "TOKEN=your_token HOOK=your_copied_path npm run set:webhook"

In this case everything should work fine.

Development

This project is under development and you can participate in it. To start this bot locally you anyway need to create a new bot with Botfather and get the TOKEN.

Telegram API accepts only https urls as webhooks for their bots, so you need to create https tunnel to your localhost. For this we can use ngrok tool and get https url provided by it.

pnpm start:tunnel

ngrok tunnel

After this you can start the serverless in offline mode [pnpm start] and set webhook for your local bot. [TOKEN=your_token HOOK=ngrok_url/your_stage pnpm run set:webhook]. Don't forget to specify stage after ngrok url. By default it's dev;

To run serverless in offline mode, your bot should be deployed anyway.

Ecosystem

Project Status Description
remark-extension The main client. Chrome web-extension.
remark-aws-backend Backend part of Remark extension. Allows to save all created bookmarks and classify them.