README.md

Full-Stack Template

Technical documentation

• Development
• Domain model
• Code style and readability
• Configuration and secrets
• Client, server, database, and testing
• Deployment and CI/CD
• Taito CLI configuration and infrastructure

Repository-local AI guidance in .agents/skills links back to these documents. Adapt this product-facing template section after creating a project from the template.

Overview

TODO: Give a short overview of the project. What is the purpose of the project? Who is the client? If there are multiple repositories, make sure to list them here.

Table of contents:

• Links
• Environments
• Contacts
  • Taito United
  • Client
• Preferred communication channels
• Responsibilities
• Intellectual property rights
• Compliance
• Application walkthrough
• How to log in
• Common issues
• FAQ

Links

TODO: List all the important links here.

• Google Drive
• Figma
• Client Bug Sheet
• ...

Environments

TODO: List all the environments here (e.g. dev, test, stag, prod).

Environment	Links	CLI
Dev	App	taito open client:dev
Test	App	taito open client:test
Staging	App	taito open client:stag
Production	App	taito open client:prod

Contacts

TODO: List all the important contacts here.

Taito United

• Project Manager: XXX

• Main developer: XXX

• Developers:

  • XXX
  • XXX
  • ...

• Designer: XXX

• Previous developers:

  • XXX
  • XXX
  • ...

Client

• Main contact: XXX
• Project Manager: XXX
• Business contact: XXX
• ...

Preferred communication channels

TODO: List the preferred communication channels here (e.g. Slack, Teams, email, phone, etc.).

Responsibilities

TODO: Who is responsible for the Git repository, environments, CI/CD, Apple App Store and Google Play Store etc.?

Intellectual property rights

IPR ownership. Also update the LICENSE file. TODO license examples

Compliance

Add compliance requirements and implementation details either here or in a separate document. For GDPR, see the data protection and privacy appendix of the Taito CLI tutorial.

Application walkthrough

TODO: Give a short walkthrough of the application. What are the main views? What are the main features? What are the main user flows?

How to log in

Give instructions on how to log in to the application. E.g.:

Important: Give links to the 1Password credentials for the application instead of writing the credentials here.

You can find the credentials for the XX application (production) here

Common issues

TODO: List all the common issues here. E.g.: performance issues, long-term technical debt etc.

FAQ

TODO: List all the development tips and tricks here. E.g.: You need to have this particular row in the DB for feature X to work