🚀 Getting Started

Learn how to install WILDCAT and get it running in minutes.

Choose Your Path

New to WILDCAT?

⚡ 5-Minute Quick Start - Get running in 5 minutes
📦 Full Installation Guide - Detailed setup with all options

Ready to build?

📚 API Reference - Learn all available endpoints
🔗 Integration Examples - Connect with n8n, Zapier, etc.

1. Install WILDCAT

git clone https://github.com/NotoriousArnav/wildcat.git
cd wildcat
npm ci
cp .env.example .env
npm run dev

2. Create Account

curl -X POST http://localhost:3000/accounts \
  -H 'Content-Type: application/json' \
  -d '{"id":"mybot","name":"My Bot"}'

3. Scan QR Code

Check server logs for QR code
Scan with your WhatsApp phone

4. Send Message

curl -X POST http://localhost:3000/accounts/mybot/message/send \
  -H 'Content-Type: application/json' \
  -d '{
    "to": "919876543210@s.whatsapp.net",
    "message": "Hello! 🐱"
  }'

System Requirements

Requirement	Minimum	Recommended
Node.js	18.x	20.x LTS
RAM	512 MB	2+ GB
Disk Space	500 MB	2+ GB
MongoDB	6.0	Latest

Installation Options

Quick Setup (5 min) - Default local setup
Full Guide - Custom configuration, Docker, production
Docker - Containerized deployment

Common Questions

Q: What do I need to get started?

Node.js 18+
MongoDB (local or Atlas)
WhatsApp account

Q: How long does setup take?

5 minutes for quick start
15 minutes for full setup with configuration

Q: Can I use MongoDB Atlas?

Yes! Free tier included. See Installation Guide

Q: What if I get stuck?

Check Troubleshooting Guide
Read the Installation Guide

Next Steps

Quick Start (5 min) - Get WILDCAT running
API Reference - Learn what you can do
Integration Examples - Connect with other tools
Deployment - Deploy to production

Already set up? Jump to API Reference