starter-template.mdx 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. ---
  2. title: "Starter Template"
  3. description: "Create your own repository from the official Agency Starter Template."
  4. icon: "layer-group"
  5. ---
  6. This is the official template for building and deploying on Agencii.
  7. Use it to create your own repository with the correct project structure, preconfigured AI rules, and deployment-ready defaults.
  8. <Info>
  9. The template includes AI rule files (for example, Cursor rules and agent workflow rules). These rules help AI coding agents generate framework-aligned agents and tools instead of generic scaffolding.
  10. </Info>
  11. ## Create Your Repository From the Template
  12. <Steps>
  13. <Step title="Open the template repository">
  14. Go to [agency-ai-solutions/agency-starter-template](https://github.com/agency-ai-solutions/agency-starter-template).
  15. Click **Use this template** and choose **Create a new repository**.
  16. ![Use this template dropdown](/images/getting-started/github-use-this-template-dropdown.png)
  17. </Step>
  18. <Step title="Create your new repository">
  19. In the GitHub form:
  20. - Confirm **Start with a template** is `agency-ai-solutions/agency-starter-template`
  21. - Set your owner and repository name
  22. - Choose visibility
  23. - Click **Create repository**
  24. ![Create repository from template](/images/getting-started/github-create-repo-from-template-crop.png)
  25. </Step>
  26. <Step title="Continue in your own repository">
  27. Open the repository you created and follow its `README.md` setup instructions.
  28. This keeps your project on your own repository from day one while preserving the template defaults.
  29. </Step>
  30. </Steps>
  31. ## Why This Template Is Recommended
  32. <CardGroup cols={2}>
  33. <Card title="AI Rules Included" icon="sparkles">
  34. Keeps AI-assisted development aligned with Agency Swarm conventions.
  35. </Card>
  36. <Card title="SaaS-Ready Structure" icon="cloud">
  37. Matches the intended Agencii flow: create repository, connect, and deploy.
  38. </Card>
  39. </CardGroup>
  40. ## Next Docs Step
  41. <CardGroup cols={2}>
  42. <Card title="Platform Overview" icon="book-open" href="/platform/overview">
  43. Continue with the Agencii flow and repository connection details.
  44. </Card>
  45. <Card title="Deployment Guide" icon="rocket-launch" href="/additional-features/deployment-to-production">
  46. Optional: review production deployment details.
  47. </Card>
  48. </CardGroup>
  49. ## Customize With AI IDEs
  50. If you are using Cursor to customize your agents, continue with [AI Agents (Cursor)](/welcome/getting-started/cursor-ide).
  51. If you are publishing reusable agencies to the marketplace, configure onboarding fields in [Marketplace Onboarding](/platform/marketplace/onboarding).
  52. <CardGroup cols={2}>
  53. <Card title="AI Agents (Cursor)" icon="cube" href="/welcome/getting-started/cursor-ide">
  54. Customize agents and tools with AI assistance.
  55. </Card>
  56. <Card title="From Scratch (Advanced)" icon="code" href="/welcome/getting-started/from-scratch">
  57. Use manual setup only when you need full control.
  58. </Card>
  59. </CardGroup>