README.md

node-bot-starter

A jump starter repo for building a Selenium-based web bot using NodeJS/TypeScript

How to use this thing

1. Download and install NodeJS >=20.10.0
   • Either get NodeJS directly or via NVM on Windows or Mac
2. Install dependencies by running npm i
3. Write the bot code in src/index.ts (a basic one has been provided as a sample)
4. Setup environment variables
   • If any secrets (usernames, passwords, etc.) are used in the bot, DO NOT COMMIT THEM
   • Instead, setup environment variables on Windows or Mac
5. Run the bot with npm run bot

Selenium setup

If Selenium can't automatically find the binaries to run the browser, you may need to set up the web drivers for Selenium:

• Download the latest Firefox driver and/or Chrome driver
• Place them in the bin directory within this repo locally
• Add the bin directory of this repo to PATH on Windows or Mac