Player5

player5 Documentation

Complete guide to streamlining your hackathon development workflow

Table of Contents

1. Getting Started2. Installation3. Configuration4. Commands
5. Features6. Automation7. Troubleshooting8. API Reference

Getting Started

player5 (P5) is designed to automate the tedious parts of hackathon development, letting you focus on building amazing projects instead of managing builds, documentation, and deployments.

Quick Setup

1
npm i player5
2
cd your-project && npx p5 init
3
npx p5 test

What P5 Does

  • Automated build testing
  • README auto-updates
  • Devpost generation
  • Commit break detection

Prerequisites

  • Node.js 16+ installed
  • Git repository initialized
  • Package.json in project root

Installation

Global Installation (Recommended)

npm i player5

Installs P5 globally so you can use it in any project

Local Installation

npm install --save-dev player5

Installs P5 as a development dependency in your project

Verify Installation

player5 --version

Configuration

Initialize P5 in Your Project

npx p5 init

This creates a .p5config.json file with default settings.

Configuration Options

{
  "buildCommand": "npm run build",
  "testCommand": "npm test",
  "autoUpdate": true,
  "notifications": {
    "buildBreaks": true,
    "deployments": true
  },
  "integrations": {
    "github": true,
    "devpost": true
  }
}

Commands

npx p5 test

Run build tests and basic validation

Example: npx p5 test --verbose
npx p5 devpost gen

Generate Devpost submission draft

Example: npx p5 devpost gen --template hackathon
npx p5 readme update

Update README with latest project info

Example: npx p5 readme update --stats
npx p5 watch

Monitor for breaking commits

Example: npx p5 watch --notify

Features

Local Build Testing

Quickly validate your project builds and passes basic tests before pushing to remote.

Commit Break Detection

Automatically detect breaking commits and notify responsible developers.

Auto-Updating README

Keep your README fresh with build status, contributors, and recent changes.

Playwright Test Generation

Create end-to-end tests by simply clicking through your application.

More sections coming soon. Check our GitHub for the latest updates.