Add AGENTS.md

This commit is contained in:
raucao committed 2026-08-22 16:19:50 -06:00
1 parent 2d71d49884
commit b06fd82610
1 file changed
+38
+38
View File
@@ -0,0 +1,38 @@
# AGENTS.md
## Overview
**Dashtab** is a client-side new-tab dashboard built with Ember.js, Vite, and Tailwind CSS. It features widgets (clock, greeting), customizable wallpapers, and third-party integrations (e.g., Discourse).
## Tech Stack
- **Framework**: Ember.js (Octane) with Embroider & Vite (`@embroider/vite`)
- **Components**: Glimmer Template Tag format (`.gjs`)
- **Styling**: Tailwind CSS v4 (`@tailwindcss/vite`) & `@tailwindplus/elements`
- **Storage**: `localforage` (IndexedDB / LocalStorage)
- **Cryptography**: Web Crypto API & `node-forge`
- **Testing**: QUnit, `@ember/test-helpers`, `qunit-dom`, `testem`
- **Package Manager**: `pnpm`
## Code Layout
- `app/components/`: UI components using `.gjs` single-file template tags.
- `app/services/`: Shared state and logic (e.g., `clock.js`, `storage.js`).
- `app/routes/` & `app/templates/`: Route definitions and `.gjs` templates.
- `app/styles/`: Application styles and Tailwind entry points.
- `doc/`: Protocol notes and integration specifications.
- `tests/`: QUnit tests (`tests/integration/` for `.gjs` components, `tests/unit/` for services).
## Commands
- `pnpm start`: Start local development server (`http://localhost:4200`).
- `pnpm test`: Build and run the test suite via Testem.
- `pnpm lint`: Run all linters (ESLint, Prettier, stylelint, template-lint).
- `pnpm lint:fix`: Auto-fix linting and formatting issues.
## Key Conventions
- **Component Format**: Author all new components and templates in Glimmer Template Tag (`.gjs`) syntax.
- **State & Services**: Use autotracking (`@tracked`) for state. Inject services with `@service`.
- **Client Persistence**: Access client storage exclusively through `service:storage` (using namespaces: `preferences`, `integrations`, `settings`).
- **Integration Security**: Cryptographic keypairs for third-party auth flows are generated via Web Crypto API and decrypted via `node-forge`; private keys must be purged once authorization is complete.
- **Testing**: Write component tests in `.gjs` with `<template>` and `render()`. Use `qunit-dom` assertions. Run `pnpm lint` and `pnpm test` to verify changes.
## Agent Restrictions
- **No Git Write Operations**: Do not run Git commands that mutate state or commit changes (e.g., `git commit`, `git add`, `git push`, etc.). All committing and staging is handled by the user.
- **No Production Builds**: Do not run `pnpm build` or production build commands. Use `pnpm test` or `pnpm start` for testing and development.