Files
Microsoft-Rewards-Script/docs/getting-started.md
Netsky 2a8ab7242f Revert "V2.4.0 (#381)" (#392)
This reverts commit f2d00225c9.
2025-10-23 13:36:09 +02:00

2.5 KiB
Raw Blame History

🚀 Getting Started

From zero to your first run in 10 minutes


Requirements

  • Node.js 20+Download here
  • Microsoft accounts with email + password
  • Optional: Docker for containers

Windows

setup\setup.bat

Linux / macOS

bash setup/setup.sh

What Does It Do?

  1. Asks for your Microsoft credentials
  2. Creates accounts.json automatically
  3. Installs dependencies
  4. Builds the project
  5. Runs your first automation (optional)

That's it! 🎉


🎯 After Installation

Run automatically once per day:

Edit src/config.jsonc:

{
  "schedule": {
    "enabled": true,
    "time": "09:00",
    "timeZone": "America/New_York"
  }
}

Start scheduler:

npm run start:schedule

Full Scheduler Guide


2 Add Notifications (Optional)

Get a summary after each run:

{
  "conclusionWebhook": {
    "enabled": true,
    "url": "https://discord.com/api/webhooks/YOUR_WEBHOOK_URL"
  }
}

Discord Setup | NTFY Setup


3 Enable Humanization (Anti-Ban)

More natural behavior:

{
  "humanization": {
    "enabled": true
  }
}

Humanization Guide


🛠️ Common Issues

Problem Solution
"Node.js not found" Install Node.js 20+ and restart terminal
"accounts.json missing" Run setup/setup.bat or create manually
"Login failed" Check email/password in accounts.json
"2FA prompt" Add TOTP secret → 2FA Guide
Script crashes Check Diagnostics Guide

🔧 Manual Setup (Advanced)

Click to expand
# 1. Configure accounts
cp src/accounts.example.json src/accounts.json
# Edit accounts.json with your credentials

# 2. Install & build
npm install
npm run build

# 3. Run
npm start

📚 Next Steps

Everything works?
Setup Scheduler for daily automation

Need 2FA?
Accounts & TOTP Guide

Want Docker?
Docker Guide

Having issues?
Diagnostics


← Back to Hub | All Docs