Skip to content

vijayatechlabs/openstart

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenStart

An agent-first project framework — a reusable, language- and framework-agnostic starting point for building software with mixed human + AI teams (Claude Code, Google AntiGravity / Gemini, Codex, Cursor, …).

Use it as a GitHub template or run one command in an existing repo, and you get, from minute one:

  • a single set of operating instructions every AI agent reads,
  • baked-in engineering standards (security, mobile-first, modern web, commenting, lean code, architecture),
  • portable guardrails + a Definition of Done every change follows,
  • a standard set of project docs (context, goals, status, tasks, changelog, decisions, risks, stakeholders, data log),
  • a built-in AEO / SEO standard, and
  • one onboarding flow that discovers a project, plans, and (on your approval) wires everything in.

Works for Next.js, Astro, plain static sites, Python services — anything — on Vercel, Netlify, Cloudflare, or a self-hosted VPS.

Built and maintained by VijayaTech Labs. MIT licensed.

Quick start

New project — click Use this template on GitHub, or:

gh repo create my-app --template vijayatechlabs/openstart

Existing project — bootstrap, then onboard:

git clone --depth 1 https://github.com/vijayatechlabs/openstart.git /tmp/openstart
cd /path/to/your/project
bash /tmp/openstart/.ai/framework/sync.sh --dry-run   # preview, writes nothing
bash /tmp/openstart/.ai/framework/sync.sh             # apply

Then run /onboard (Claude Code; /init-project is an alias) or follow .ai/framework/ONBOARD.md (any other agent).

How onboarding works — one flow for new and existing projects

A single state-aware pipeline that detects whether the project is brand-new, an existing codebase, or already on the framework, and adapts:

Discover → Plan → ⟨you approve once⟩ → Apply → Verify

The agent makes every mechanical decision; you approve one plan (file actions

  • the 2–3 real choices). Writes are scoped to .ai/ + the agent stubs, on a branch, never touching your application code. From then on, every agent session reads .ai/docs/ for context and updates it as work happens.

How "one file for all agents" works

Each agent auto-loads a different filename. Here they're all thin stubs that redirect to one canonical file, so you maintain a single source of truth:

CLAUDE.md   ─┐
AGENTS.md   ─┼──►  .ai/framework/AGENT-GUIDE.md   (edit this one)
GEMINI.md   ─┘

Why .ai/ and not the repo root

All framework/meta is consolidated under one .ai/ umbrella so it never tangles with real application code. The only meta files at the repo root are the three agent stubs and this README — everything those tools require to be at root. Your src/, apps/, packages/, etc. live at the root alongside them.

Layout

.
├── README.md / LICENSE
├── CLAUDE.md / AGENTS.md / GEMINI.md   ← thin stubs → .ai/framework/AGENT-GUIDE.md
├── .claude/
│   ├── commands/                       ← /onboard (+ /init-project alias)
│   └── skills/aeo-framework/SKILL.md   ← invokable AEO skill (Claude Code)
├── .ai/                      ← all framework + project meta (kept out of code)
│   ├── framework/              ← the reusable standard (edit-once source of truth)
│   │   ├── AGENT-GUIDE.md        ← canonical instructions for ALL agents
│   │   ├── ONBOARD.md            ← the adopt/scaffold/update flow (all agents)
│   │   ├── sync.sh               ← installer/updater (mechanical half of /onboard)
│   │   ├── DOC-RULES.md          ← which doc to write where
│   │   └── aeo/                  ← AEO/SEO framework, prompts, checklist
│   ├── docs/                   ← per-project living docs (filled during onboarding)
│   │   ├── PROJECT-CONTEXT · STACK · GOALS · CURRENT-STATUS · TASKS · NEXT-ACTIONS
│   │   ├── CHANGELOG · DECISIONS · RISKS · STAKEHOLDERS · AEO-CHANGES · DATA-LOG
│   │   └── data/                ← datasets / exports / research dumps
│   └── examples/               ← a worked sample (delete in your own project)
└── (your code: src/ | apps/ | packages/ | …)

Keeping projects up to date

The framework is versioned (.ai/framework/VERSION, git tags). To pull the latest standard into a project that already uses it:

bash .ai/framework/sync.sh --dry-run                 # preview
bash .ai/framework/sync.sh                            # latest
FRAMEWORK_REF=v1.0.0 bash .ai/framework/sync.sh       # pin to a release

It updates only the reusable standard (.ai/framework/, .claude/commands/, .claude/skills/, the agent stubs) and never touches your .ai/docs/, .ai/examples/, .claude/settings*.json, or your code. Review git diff, commit.

Contributing

OpenStart is intentionally opinionated and lean. Issues and PRs are welcome — please keep changes framework-agnostic and favor folding into existing files over adding new ones. See .ai/framework/AGENT-GUIDE.md for the conventions the framework holds itself to.

License

MIT © VijayaTech Labs.

About

AEO-first custom application framework for Websites, Applications.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages