Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cba85/telegram-wiptimelinebot
🚧 Create your own WIP.co todos timeline of your favorite makers on Telegram.
https://github.com/cba85/telegram-wiptimelinebot
cheerio express mysql nodejs nunjucks telegram-bot
Last synced: 2 months ago
JSON representation
🚧 Create your own WIP.co todos timeline of your favorite makers on Telegram.
- Host: GitHub
- URL: https://github.com/cba85/telegram-wiptimelinebot
- Owner: cba85
- Created: 2021-06-26T12:06:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-13T13:16:24.000Z (9 months ago)
- Last Synced: 2024-05-13T14:33:26.975Z (9 months ago)
- Topics: cheerio, express, mysql, nodejs, nunjucks, telegram-bot
- Language: JavaScript
- Homepage: https://wipbot.2facto.com
- Size: 232 KB
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WIP.co telegram timeline
Create your custom [WIP.co](https://wip.co/) completed todos timeline of your favorite makers on Telegram.
🤖 To use the bot, just add [WipTimelineBot](https://t.me/WipTimelineBot) on Telegram !
---
This is a simple app to parse [WIP.co](https://wip.co/) website, get your favorite makers completed todos, and send them on Telegram using a Telegram bot.
This app doesn't require an active account on the website because it doesn't use wip.co API, but scraps wip.co website instead using [cheerio](https://cheerio.js.org/).
This app contains a entry point `index.js` that is the Telegram bot listener.
It also contains 2 scripts located in `bin/` folder:
- `clean.js`: remove todos saved in database older than a week to clean database
- `parse.js`: scraper to parse [WIP.co](https://wip.co/) todos
## Requirements
- A MySQL server
- A Telegram bot (create your own bot using Telegram's BotFather and grab your TOKEN)
## Install
```
$ npm install
```
Create a `.env` file based on `.env.example` file:
```bash
cp -v .env.example .env
```
Add your database and Telegram credentials into the `.env` file.
### Database
Create a MySQLtable based on the MySQL schema located in `db/` folder.
## Usage
Launch bot:
```
$ node index.js
```
In your Telegram bot, add usernames you want to follow using `/follow @username` command.
Then launch the script to parse and get [WIP.co](https://wip.co/) todos of these users inside your Telegram bot:
```
$ node bin.parse.js [MAX_PAGE_TO_SCRAP]
```
Default max page to scrap is 1.
Use a cron scheduler to automatically receive updates (completed todos) from your favorite makers.
## Commands
- `/start` : list commands available
- `/following`: list makers you follow
- `/follow @username`: follow @username
- `/unfollow @username`: unfollow @username
- `/debug`: get Telegram chatId and username
### Telegram commands list
```txt
start - Main menu
following - list makers you follow
follow - follow a maker
unfollow - unfollow a maker
debug - Debug mode
```
## Resources
- PostgreSQL: https://devcenter.heroku.com/articles/heroku-postgresql#connecting-in-node-js *(not using Heroku and PostgreSQL anymore)*
- Pupeeter: https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#running-puppeteer-on-heroku *(replaced by Cheerio)*
- Heroku Telegram Bot: https://github.com/odditive/heroku-node-telegram-bot *(not using Heroku anymore)*