Files
Microsoft-Rewards-Script/docs/getting-started.md
Light dc7e122bce V2.1 (#375)
* feat: Implement edge version fetching with retry logic and caching

* chore: Update version to 2.1.0 in package.json

* fix: Update package version to 2.1.0 and enhance user agent metadata

* feat: Enhance 2FA handling with improved TOTP input and submission logic

* fix: Refactor getSystemComponents to improve mobile user agent string generation

* feat: Add support for cron expressions for advanced scheduling

* feat: Improve humanization feature with detailed logging for off-days configuration

* feat: Add live log streaming via webhook and enhance logging configuration

* fix: Remove unused @types/cron-parser dependency from devDependencies

* feat: Add cron-parser dependency and enhance Axios error handling for proxy authentication

* feat: Enhance dashboard data retrieval with retry logic and diagnostics capture

* feat: Add ready-to-use sample configurations and update configuration settings for better customization

* feat: Add buy mode detection and configuration methods for enhanced manual redemption

* feat: Migrate configuration from JSON to JSONC format for improved readability and comments support

feat: Implement centralized diagnostics capture for better error handling and reporting

fix: Update documentation references from config.json to config.jsonc

chore: Add .vscode to .gitignore for cleaner project structure

refactor: Enhance humanization and diagnostics capture logic in BrowserUtil and Login classes

* feat: Reintroduce ambiance declarations for the 'luxon' module to unlock TypeScript

* feat: Update search delay settings for improved performance and reliability

* feat: Update README and SECURITY documentation for clarity and improved data handling guidelines

* Enhance README and SECURITY documentation for Microsoft Rewards Script V2

- Updated README.md to improve structure, add badges, and enhance clarity on features and setup instructions.
- Expanded SECURITY.md to provide detailed data handling practices, security guidelines, and best practices for users.
- Included sections on data flow, credential management, and responsible use of the automation tool.
- Added a security checklist for users to ensure safe practices while using the script.

* feat: Réorganiser et enrichir la documentation du README pour une meilleure clarté et accessibilité

* feat: Updated and reorganized the README for better presentation and clarity

* feat: Revised and simplified the README for better clarity and accessibility

* Update README.md
2025-10-11 16:54:07 +02:00

3.1 KiB
Raw Blame History

🚀 Getting Started

🎯 From zero to earning Microsoft Rewards points in minutes
Complete setup guide for beginners


Requirements

  • Node.js 18+ (22 recommended) — Download here
  • Microsoft accounts with email + password
  • Optional: Docker for containerized deployment

🎬 One Command, Total Automation

# 🪟 Windows
setup/setup.bat

# 🐧 Linux/macOS/WSL  
bash setup/setup.sh

# 🌍 Any platform
npm run setup

That's it! The wizard will:

  • Help you create src/accounts.json with your Microsoft credentials
  • Install all dependencies automatically
  • Build the TypeScript project
  • Start earning points immediately

🛠️ Manual Setup

📖 Prefer step-by-step? Click here

1 Configure Your Accounts

cp src/accounts.example.json src/accounts.json
# Edit accounts.json with your Microsoft credentials

2 Install Dependencies & Build

npm install
npm run build

3 Choose Your Mode

# Single run (test it works)
npm start

# Automated daily scheduler (set and forget)
npm run start:schedule

🎯 What Happens Next?

The script will automatically:

  • 🔍 Search Bing for points (desktop + mobile)
  • 📅 Complete daily sets (quizzes, polls, activities)
  • 🎁 Grab promotions and bonus opportunities
  • 🃏 Work on punch cards (multi-day challenges)
  • Daily check-ins for easy points
  • 📚 Read articles for additional rewards

All while looking completely natural to Microsoft! 🤖


🐳 Docker Alternative

If you prefer containers:

# Ensure accounts.json and config.jsonc exist
docker compose up -d

# Follow logs
docker logs -f microsoft-rewards-script

Full Docker Guide →


🔧 Next Steps

Once running, explore these guides:

Priority Guide Why Important
High Accounts & 2FA Set up TOTP for secure automation
High Scheduling Configure automated daily runs
Medium Notifications Get alerts on your phone
Low Humanization Advanced anti-detection

🆘 Need Help?

Script not starting?Troubleshooting Guide
Login issues?Accounts & 2FA Setup
Want Docker?Container Guide

Found a bug? Report it here
Need support? Join our Discord