Skip to content

SETUP_STEPS.md

Latest commit

 

History

History
44 lines (37 loc) · 1.89 KB

SETUP_STEPS.md

File metadata and controls

44 lines (37 loc) · 1.89 KB
Raw

Setup Steps

  1. Download 
    npx degit epicweb-dev/workshop-template YOUR_REPO_NAME
  2. Find/replace github repo name from "workshop-template" to "your-repo-name" (the org is already set to "epicweb-dev")
  3. Find/replace the title of the workshop from "Workshop Title 🎃" to "Your Workshop Title 🦊" (emoji optional, but fun, choose something you think represents your topic in some clever way).
  4. Find/replace the subtitle of the workshop from "Workshop subtitle" to "Your subtitle" (this will appear on the top of the README as well as on the og:image when shared on social media)
  5. Update the workshop summary in the README.md
  6. Update the Prerequisites, pre-workshop resources, and if necessary system requirements in the README.md
  7. Update epicshop.instructor and author properties in package.json
  8. Update the public/images/instructor.png with your own image
  9. Update all dependencies 
    ./epicshop/update-deps.sh
  10. Ask Kent to create a Fly app for your workshop to deploy to. Just tell him what it's called in the epicshop/fly.toml. No need to wait on Kent for this step, just let him know and continue to the next step, he'll get to it soon.
  11. Initialize git and create a github repo on epicweb-dev with the name you chose

And as the last step, delete this file, create your initial commit, push it, and start working on your exercises!

Creating Workshops with AI Agents

This template includes comprehensive documentation for creating workshops using AI agents. See the instructor/ directory for:

  • workflow/ - Step-by-step agent workflow (start here)
  • Reference docs on planning, exercises, MDX, testing, and best practices

To create a new workshop, tell an AI agent:

"I want to create an Epic Workshop about [YOUR TOPIC]. Please read /instructor/workflow/01-discovery.md and help me build it."