This page contains a short summary of the project itself. See DEVELOPMENT.md for development instructions.
Minimal project template for Taito CLI. It includes support for version control, code quality checking, links, and npm. It also provides CI/CD templates for multiple providers, and some documentation templates.
You can create a new project from this template by running taito project create: minimal-template. Later you can upgrade your project to the latest version of the template by running taito project upgrade. You can also migrate an existing project that does not currently use Taito CLI by running taito project migrate: minimal-template in your project root folder.
Short description of the project: vision, purpose, company, etc.
Table of contents:
- Links
- Usage
- Contacts
- Responsibilities
- Intellectual property rights
- Manually configured settings
- Recurring issues and solutions
- Miscellaneous notes
- Conventions
- Architecture Overview
- Security
- Compliance
Non-production basic auth credentials: USERNAME / PASSWORD
LINKS WILL BE GENERATED HERE
You can update this section by configuring links in
taito-config.shand runningtaito project docs.
Some notes about testing and usage either here or in a separate document.
- Project Manager: John Doe, Company co.
- Designer: Jane Doe, Company co.
NOTE: It is recommended to use a shared address book or CRM for keeping the contact details like email and phone number up-to-date.
Hosting, billing and control of 3rd party services, SSL/TLS certificates, etc.
IPR ownership. Also update the LICENSE file. TODO license examples
Try to keep all configurations in version control. However, if you have configured something manually, describe manually configured settings here.
See trouble.txt or run taito trouble.
Misc notes.
Project specific conventions.
DIAGRAM: You can use Gravizo for making a architecture diagram if the diagram does not contain any confidential information. Note that architecture diagram is not mandatory if the architecture is very simple.
- Client uses Google Maps
- Server uses system X for authorization (OAUTH)
- Server fetches products from system Y (REST/json)
- Server sends email using Sendgrid (REST/json)
Only non-trivial processes need to be described here (e.g. scheduled batch processing), though it might be a good idea to describe one or two basic scenarios also. Architecture is the main focus here. User stories should be documented elsewhere (e.g. wiki).
- User performs action on UI
- Server authorizes action by system X
- Server reads/updates database
- Server returns value
- User performs action on UI
- Server adds message to queue
- ...
- ...
- Server sends email
- ...
- ...
Add security details either here or in a separate document. See the security appendix of the Taito CLI tutorial.
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.