joshlucpoll/nearcut-autobook repository overview

⁠Nearcut Auto-Booking

A simple telegram bot that allows you to auto-book barbers appointments using the Nearcut booking system. This application was primarily developed as a way of auto-booking cancellations when wait times are long for appointments.

The bot will look ahead a specified number of days for available appointments that meet a defined 'availability filter' and then automatically book the appointment. A scheduler can also be set up to continuously look for new/cancelled appointments until one is found that matches the criteria, at which point the scheduler will automatically stop.

⁠Setup

⁠Telegram Bot and Configuration

Create a new bot by messaging @BotFather⁠ with /newbot on Telegram and follow the prompts. Save the TELEGRAM_TOKEN for later use.

⁠Getting Telegram ID

You will also need to get your TelegramID, this is so only you have access to the bot. Message @userinfobot⁠ /start to get your 'TELEGRAM_ID'

⁠Installation

The script can be run on any stand-alone system with node installed or as a Docker container

⁠Environment Variables

The script requires TELEGRAM_TOKEN and TELEGRAM_ID as environment variables for the bot to run. Other enviornment variables are set using the /editconfig Telegram bot command or can be added by running the set-store.ts script.

⁠Standalone

1. Clone the repo : git clone https://github.com/joshlucpoll/nearcut-autobook
2. npm i
3. npx playwright install if this is the first time using playwright on your system
4. node index.ts

⁠Docker

docker run --name=nearcut-autobooking -d \
  --restart=always \
  -e 'TELEGRAM_TOKEN=<telegram_token>' \
  -e 'TELEGRAM_ID=<telegram_id>' \
joshlucpoll/nearcut-autobook

⁠DATE_FILTER Object

The DATE_FILTER object defines what days and times you are avalible, here is an example configuration:

{
    "Monday": true,
    "Tuesday": [
        ["8:00", "8:30"],
        ["17:00", "19:00"]
    ],
    "Wednesday": false,
    "Thursday": [
        ["8:15", "10:30"],
        ["13:00", "15:45"],
        ["17:10", "18:00"]
    ],
    "Friday": true,
    "Saturday": true,
    "Sunday": false
}

It must contain every day of the week as a key, the value can be either:

• true - Free all day
• false - Not avalible all day
• List of 'from' and 'to' times that define what periods in that day are free

For the example above:

• Tuesday is available to book 8:00am-8:30am OR 5:00pm-7:00pm
• Thurday is avaliable to book 8:10am-10:30am OR 1:00pm-1:45pm OR 5:10pm-6:00pm