dekodeinteraktiv/teft-base

Dekode WordPress boilerplate with modern development tools, easier configuration, and an improved folder structure

Project name

If you are looking for instructions on how to use and install project-base, please refer to the file INSTALLATION.md, _(*1)

Short summary of the main functionality and purpose of the project., _(*2)

Made by

List the people who have been extensively involved in creating this website, _(*3)

How to build

List any steps necessary to get this project up and running on a local machine. This could consist of, but is not limited to, these points:, _(*4)

• NPM/yarn installation (please include a version of node on which the install process is known to work)
• SASS compilation
• JS compilation
• Composer quirks
• Symlinking

Custom wp-cli commands

List and document any custom-made wp-cli commands on this site., _(*5)

Third party integrations

List any third-party integrations which are included in the project. Each entry should include:, _(*6)

Where in the project the integration is used What purpose the integration serves. Is it used when the user performs a special page query, or is it an import routine which runs at specific intervals?, _(*7)

How the integration is configured Any constants be it PHP or Javascript that need to be set, and whether these constants are different on stage and production., _(*8)

Link to documentation Add a link to any relevant documentation, and specify which version of an API we use., _(*9)

Authorization Add some words about how the third-party server authenticates incoming requests and add any API-keys necessary., _(*10)

Any terminal commands that could be useful Any custom made wp-cli commands which communicate with the third party, should be documented here. Also a link to any commands included in plugins which comunicate with the third-party, should be included., _(*11)

Cronjobs

List all non-standard cronjobs on the site and say a few words about the purpose of each of them., _(*12)

Anonymization

Project data is anonymized using a config file, anonymize.config.json, where the developer is expected to declare any Personally Identifiable Information (PII) for the project in a data structure relating to database tables and entries., _(*13)

This anonymization is performed using the anonymize-mysqldump project, where you can also see the structure of the config file., _(*14)

The default configuration file provides support for a vanilla WordPress installation, with just data relating to comments and usermeta accounted for., _(*15)