docs: add README.md and AGENTS.md #28

Merged
davide merged 3 commits from docs/readme-and-agents into main 2026-06-28 10:42:25 +00:00
Member

Summary

This PR adds the missing README.md and AGENTS.md documentation files for the Events Cash Register project.

README.md

  • Project overview and feature list
  • Tech stack details
  • Installation and setup instructions
  • Environment variable documentation
  • Linting and formatting commands
  • Project structure explanation
  • Database schema overview

AGENTS.md

  • Code style guidelines for TypeScript and Svelte
  • Naming conventions
  • Import patterns and path aliases
  • Database conventions (Drizzle ORM)
  • Authentication patterns
  • Form and validation patterns
  • CI/CD workflow information
  • Common tasks reference
## Summary This PR adds the missing `README.md` and `AGENTS.md` documentation files for the Events Cash Register project. ### README.md - Project overview and feature list - Tech stack details - Installation and setup instructions - Environment variable documentation - Linting and formatting commands - Project structure explanation - Database schema overview ### AGENTS.md - Code style guidelines for TypeScript and Svelte - Naming conventions - Import patterns and path aliases - Database conventions (Drizzle ORM) - Authentication patterns - Form and validation patterns - CI/CD workflow information - Common tasks reference
docs: add README.md and AGENTS.md
Some checks failed
check-build.yaml / Check that project builds (pull_request) Successful in 1m3s
check-commitizen.yaml / Check the PR title (pull_request) Successful in 3s
check-formatter.yaml / Checks with formatters (pull_request) Failing after 10s
check-linter.yaml / Checks with linters (pull_request) Successful in 15s
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 3s
forgejo-agent / LLM Bot response generation (pull_request) Successful in 3s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 19s
83ba4674e3
- Add comprehensive README.md with project overview, features, tech stack,
  installation instructions, and project structure
- Add AGENTS.md with coding guidelines, conventions, and common tasks
  for AI agents and contributors
chore: add license
Some checks failed
check-formatter.yaml / Checks with formatters (pull_request) Failing after 12s
check-linter.yaml / Checks with linters (pull_request) Successful in 13s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 21s
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
check-build.yaml / Check that project builds (pull_request) Successful in 1m5s
6cd88317f9
chore: update and format files
All checks were successful
check-formatter.yaml / Checks with formatters (pull_request) Successful in 11s
check-linter.yaml / Checks with linters (pull_request) Successful in 13s
check-syntax.yaml / Checks with static tools (pull_request) Successful in 22s
check-yamllint.yaml / Lint yaml files (pull_request) Successful in 2s
check-build.yaml / Check that project builds (pull_request) Successful in 1m2s
84066f46b5
davide scheduled this pull request to auto merge when all checks succeed 2026-06-28 10:41:49 +00:00
davide merged commit e2422b2333 into main 2026-06-28 10:42:25 +00:00
davide deleted branch docs/readme-and-agents 2026-06-28 10:42:25 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
projects/events-cash-register!28
No description provided.