Skip to main content

Getting Started

Ready to transform your testing experience? Follow this guide to get TestPig.io up and running in no time!

Quick Setup Guide ⚡​

1. Create Your Organization Home 🏢​

After signing up, you'll create your organization space — think of it as your test reporting headquarters where all the magic happens!

Time to Completion

This step takes less than 2 minutes!

2. Launch Your First Project 🎯​

Projects in TestPig.io are flexible containers for your testing efforts. They can represent:

  • 🌟 A shiny new feature
  • 📱 Your amazing product
  • 🚀 An exciting initiative
  • 🧩 Any logical grouping that makes sense to your team

Here's how:

  1. Head to the Projects dashboard
  2. Hit the "Create New Project" button
  3. Give your project an awesome name
  4. Save and celebrate! 🎉
Project ID

You'll receive a unique Project ID after creation. Keep this treasure safe — you'll need it when connecting your test reporters!

3. Grab Your API Key 🔑​

Think of this as your VIP access pass to TestPig.io:

  1. Navigate to Organization Settings > API
  2. Click "Create New API Key"
  3. Copy that shiny new key
  4. Store it somewhere secure (but not so secure you forget where it is!)

4. Connect Your Test Reporter 🔌​

Now for the fun part — linking your testing framework to TestPig.io:

  1. Pick your testing framework from our Reporters collection
  2. Follow the simple setup instructions (we promise it's painless!)
  3. Run a test to see the magic happen

Environment Variables Cheat Sheet 📝​

Add these to your test environment and you're good to go:

TESTPIG_PROJECT_ID=your-project-id
TESTPIG_RUN_ID=your-run-id # Optional
TESTPIG_API_KEY=your-api-key

What each one does:

  • TESTPIG_PROJECT_ID: Points to your specific project
  • TESTPIG_RUN_ID: Names your test run (defaults to your git branch if not explicitly set)
  • TESTPIG_API_KEY: Your secret handshake with our API
Learn More

For detailed strategies on using environment variables effectively, check out our Best Practices guide.

What's Next on Your Journey? 🗺️​

Remember, we're just an email away if you need help! Happy testing!