Skip to content

docs: add CLAUDE.md agent instructions #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KooshaPari merged 1 commit into from
Mar 27, 2026
Merged

docs: add CLAUDE.md agent instructions #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# BytePort

Infrastructure-as-code (IAC) deployment and UX generation platform for software developer portfolios. Reads an IAC file defining application structure, deploys from GitHub to AWS, and auto-generates portfolio site templates via LLM.

## Stack
- Language: Go (backend), TypeScript/JavaScript (frontend)
- Key deps: AWS SDK, GitHub API, OpenAI/LLM client
- Structure: `backend/` + `frontend/` monorepo

## Structure
- `backend/`: Go server handling IAC parsing, AWS deployment, LLM integration
- `frontend/`: Portfolio site frontend (TypeScript)
- `start` / `start.bat`: Dev startup scripts

## Key Patterns
- IAC-driven: single config file defines application + infra
- AWS deployment (EC2/ECS/Lambda depending on app type)
- LLM-generated portfolio widgets and object templates
- GitHub repo as the source of truth for app code

## Adding New Functionality
- Backend logic: `backend/` (Go modules)
- Frontend components: `frontend/`
- New IAC resource types: extend the IAC parser in `backend/`
- Run `./start` for local development
Loading