Skip to content

GITHUB_SETUP.md

Latest commit

 

History

History
227 lines (174 loc) · 5.6 KB

GITHUB_SETUP.md

File metadata and controls

227 lines (174 loc) · 5.6 KB
Raw

Setup Instructions for GitHub Repository

After creating your GitHub repository, follow these steps to complete the setup:

1. Update Repository URLs

Replace devmode-id with your actual GitHub username in these files:

Files to update:

  • README.md (multiple locations)
  • README.id.md (multiple locations)
  • CONTRIBUTING.md
  • CONTRIBUTING.id.md
  • package.json
  • CHANGELOG.md
  • PROJECT_SUMMARY.md
  • docs/FAQ.md
  • docs/EXAMPLES.md

Quick find and replace:

# Linux/Mac
find . -type f -name "*.md" -o -name "package.json" | xargs sed -i 's/devmode-id/YOUR_GITHUB_USERNAME/g'

# Windows (PowerShell)
Get-ChildItem -Recurse -Include *.md,package.json | ForEach-Object {
    (Get-Content $_.FullName) -replace 'devmode-id', 'YOUR_GITHUB_USERNAME' | Set-Content $_.FullName
}

2. Update Contact Information

Replace support@devmode.id with your actual contact email in:

  • README.md
  • README.id.md
  • CONTRIBUTING.md
  • CONTRIBUTING.id.md
  • SECURITY.md
  • docs/FAQ.md

3. Initialize Git Repository

# If not already initialized
git init

# Add all files
git add .

# Create initial commit
git commit -m "Initial commit: Open Browser Rendering v1.0.0"

# Add remote repository
git remote add origin https://github.com/YOUR_USERNAME/OpenBrowserRendering.git

# Push to GitHub
git branch -M main
git push -u origin main

4. Configure GitHub Repository Settings

Repository Settings:

  1. Go to repository Settings
  2. Under "General":
    • Add description: "Open-source alternative to Cloudflare Browser Rendering API"
    • Add website: Your deployment URL (if available)
    • Add topics: browser-rendering, screenshot, pdf, playwright, hono, docker, self-hosted, cloudflare-alternative

Enable Features:

  1. Issues: ✅ Enable
  2. Discussions: ✅ Enable (recommended)
  3. Projects: ✅ Enable (optional)
  4. Wiki: ✅ Enable (optional)

Branch Protection:

  1. Go to Settings → Branches
  2. Add rule for main branch:
    • ✅ Require pull request reviews before merging
    • ✅ Require status checks to pass before merging
    • ✅ Require branches to be up to date before merging

5. Setup GitHub Actions

The workflows are already configured in .github/workflows/. They will run automatically on:

  • Push to main or develop branches
  • Pull requests to main branch

Secrets to add (if needed):

  1. Go to Settings → Secrets and variables → Actions
  2. Add repository secrets:
    • DOCKER_USERNAME (if publishing to Docker Hub)
    • DOCKER_PASSWORD (if publishing to Docker Hub)

6. Create GitHub Releases

First Release (v1.0.0):

  1. Go to Releases → Create a new release
  2. Tag: v1.0.0
  3. Title: Open Browser Rendering v1.0.0
  4. Description: Copy from CHANGELOG.md
  5. Publish release

7. Setup GitHub Pages (Optional)

For documentation hosting:

  1. Go to Settings → Pages
  2. Source: Deploy from a branch
  3. Branch: main / docs
  4. Save

8. Add Repository Badges

Add these badges to your README.md (already included, just verify):

  • License badge
  • Node.js version badge
  • Docker badge
  • Build status badge (after first CI run)

9. Create Discussion Categories

Go to Discussions → Categories and create:

  • 📢 Announcements
  • 💡 Ideas
  • 🙏 Q&A
  • 💬 General
  • 🐛 Bug Reports (link to Issues)

10. Pin Important Issues/Discussions

Create and pin:

  • Welcome message for new contributors
  • Roadmap discussion
  • FAQ discussion

11. Add Collaborators (Optional)

If you have team members:

  1. Go to Settings → Collaborators
  2. Add team members with appropriate permissions

12. Setup Webhooks (Optional)

For Discord/Slack notifications:

  1. Go to Settings → Webhooks
  2. Add webhook URL
  3. Select events to trigger

13. Create Project Board (Optional)

For task management:

  1. Go to Projects → New project
  2. Create columns:
    • 📋 Backlog
    • 🚧 In Progress
    • 👀 Review
    • ✅ Done

14. Update Social Preview

  1. Create a social preview image (1280x640px)
  2. Go to Settings → General
  3. Upload image in "Social preview" section

15. Verify Everything

Checklist:

  • All URLs updated with correct username
  • Contact emails updated
  • Repository pushed to GitHub
  • Repository settings configured
  • GitHub Actions running successfully
  • Issues and Discussions enabled
  • README displays correctly
  • License file present
  • Contributing guidelines accessible
  • Security policy visible

16. Promote Your Project

After setup:

  • Share on social media
  • Post on Reddit (r/selfhosted, r/opensource)
  • Submit to awesome lists
  • Write a blog post
  • Create demo video
  • Add to Product Hunt

Quick Setup Script

#!/bin/bash

# Replace with your information
GITHUB_USERNAME="your-username"
CONTACT_EMAIL="your-email@example.com"

# Update all files
find . -type f \( -name "*.md" -o -name "package.json" \) -exec sed -i "s/devmode-id/$GITHUB_USERNAME/g" {} +
find . -type f -name "*.md" -exec sed -i "s/support@devmode.id/$CONTACT_EMAIL/g" {} +

# Git setup
git init
git add .
git commit -m "Initial commit: Open Browser Rendering v1.0.0"
git branch -M main
git remote add origin https://github.com/$GITHUB_USERNAME/OpenBrowserRendering.git
git push -u origin main

echo "✅ Setup complete!"
echo "Next steps:"
echo "1. Configure repository settings on GitHub"
echo "2. Enable Discussions and Issues"
echo "3. Create first release (v1.0.0)"
echo "4. Add topics and description"

Support

If you need help with setup:

  • Check GitHub documentation
  • Ask in Discussions
  • Create an issue

Note: This file is for setup only and should not be committed to the repository. Add it to .gitignore after use.