Dette prosjektet er designet som en standardisert mal for PHP-utvikling med fokus på optimal AI-assistert kodegenerering. Målet er å skape et rammeverk hvor AI-agenter kan produsere konsistent, korrekt og vedlikeholdbar kode.
AI-generert kode er bare så god som konteksten den får. Dette prosjektet implementerer strukturer og dokumentasjonsmetoder som sikrer at AI-agenter har tilgang til all nødvendig informasjon for å generere produktionsklar kode.
- PHP - Primær backend-teknologi
- Composer - Avhengighetshåndtering
- Tailwind CSS v4 - Styling med innebygd dark mode
- Twig - Template engine
- Node.js - For frontend-verktøy (Tailwind kompilering)
- Meta-filer:
.meta.jsoni alle template-mapper dokumenterer komponentparametere - AI-guider: Spesialiserte
.mdfiler for AI-agent instruksjoner - Konsistent navngivning: Forutsigbare mønstre for mapper og filer
/**
* @ai-meta .meta.json files in template directories for component parameters
* @ai-guide /docs-ai/how-to-render-twig-templates.md Usage patterns and syntax
*/AI-spesifikke tags i docblocks som peker mot relevant kontekst uten å forurense standard dokumentasjon.
- Twig-komponenter med full parameterdokumentasjon
- Elegant rendering-syntax:
twig('@components/card.twig', $data) - Automatisk path-resolving og feilhåndtering
Systemet støtter både enkle og avanserte brukstilfeller uten å komplisere grunnleggende operasjoner.
- Dokumentert oppdateringsprosess for å holde meta-informasjon synkronisert
- Fremtidsrettet for automatisering av dokumentasjonsgenerering
/
├── templates/twig/ # Twig templates med AI-dokumentasjon
│ ├── components/ # Gjenbrukbare UI-komponenter
│ ├── base/ # Layout templates
│ ├── partials/ # Header, footer, etc.
│ └── _ai_guide.md # AI-instruksjoner for template-bruk
├── tailwind/ # Tailwind source files
├── public_html/ # Web root
├── docs/ # Prosjektdokumentasjon
└── node_modules/ # Frontend dependencies
// Enkel, konsistent syntax
echo twig('@components/button.twig', [
'text' => 'Click me',
'type' => 'primary'
]);Automatisk dark mode i alle komponenter uten ekstra konfigurasjon.
Alle komponenter har dokumenterte parametere i tilhørende .meta.json filer.
- Les meta-filer først - Sjekk
.meta.jsonfør du foreslår komponentbruk - Følg etablerte mønstre - Bruk eksisterende konvensjoner for konsistens
- Oppdater dokumentasjon - Ved endringer, oppdater tilhørende meta-filer
- Test komponentparametere - Verifiser at alle obligatoriske parametere er inkludert
Dette prosjektet er designet for utviklere som kommuniserer gjennom naturlig samtale fremfor strukturerte lister. AI-agenter bør være oppmerksomne på:
- Diskusjonsmodus: Utforsking av alternativer og idéutveksling
- Kodemodus: Spesifikke tekniske krav og implementasjonsdetaljer
Overgangssignaler til kodemodus inkluderer tekniske constraints, feilmeldinger, eller spesifikke implementasjonskrav.
- Klon prosjektet
- Installer avhengigheter:
composer install && npm install - Kompiler CSS:
npm run build - Les hensyn som gjelder for prosjektet i
/docs - Utforsk komponentene via
.meta.jsonfiler
Before you can run this project, ensure you have the following installed:
- Composer (PHP dependency manager)
- Node.js & npm (JavaScript dependency manager)
- Web server capable of serving PHP 8.2+ files (Apache, Nginx, or built-in PHP server)
-
Clone the repository and navigate to the project directory in your terminal
-
Install dependencies:
composer install npm install
-
Configure credentials:
- Copy
_credentials.phptocredentials.phpin the project root - Update
credentials.phpwith your actual database/API credentials - Important: Never commit
credentials.phpto Git (it's in .gitignore)
- Copy
-
Set up web server to serve files from the
public_html/directory -
Access your application through your web server
Read the documentation first! Check the /docs folder for project-specific guidelines and requirements that must be maintained at all times.
Changes to certain directories require additional build processes:
- Templates (
/templates/): Follow Twig templating guidelines in project docs - Styles (
/tailwind/): Requires CSS compilation - see styling guidelines below
When adding custom CSS styles:
- Create .scss file in /tailwind/custom-styles/ with descriptive name
- Start file with detailed comment block explaining purpose and usage
- Write CSS code - no limitations on complexity
- Run npm run ai-agent-rebuild to auto-generate imports and build
- Active file:
credentials.php(not in Git) - Template file:
_credentials.php(tracked in Git) - Rule: Any changes to
credentials.phpmust also be reflected in_credentials.phptemplate - The template file should always represent 100% of the structure/values used in the system
-
composer install- Install/update PHP dependencies -
npm install- Install/update Node.js dependencies -
npm run build- Compile Tailwind CSS for production -
watch- Re-build with watch adedde for auto-rebuilds -
ai-agent-rebuild- AI Agent re-build command -
rebuild- Human re-build command
/docs # Project documentation and guidelines
/logs # Apache logs
/node_modules # Node.js dependencies
/public_html # Public web files (document root)
/src # Custom business logic
/tailwind # Custom styles and Tailwind config
/templates # Twig templates with metadata
/vendor # Composer dependencies
credentials.php # Local credentials (not in Git)
_credentials.php # Credential template (in Git)
Mål: Skape et miljø hvor AI kan generere produktionsklar PHP-kode med minimal menneskelig intervensjon, samtidig som koden forblir vedlikeholdbar og utvidbar.
kim at steinhaug dot com