Skip to content

Latest commit

 

History

History
118 lines (97 loc) · 3.52 KB

README.md

File metadata and controls

118 lines (97 loc) · 3.52 KB
Raw

Tofino

Tofino

A WordPress starter theme for jumpstarting custom theme development.

Developed by Daniel Hewes, Jake Gully.

Ongoing development is sponsored by Creative Dot

Heavily inspired the by awesome WordPress starter theme Sage by Roots from Ben Word and Scott Walkinshaw.

Requirements

Prerequisite How to check How to install
PHP >= 8.2.0 php -v php.net
Node.js >= 20.0.0 node -v nodejs.org
Composer >= 2.0.0 composer -V getcomposer.org

Installation

  • Download the latest tagged release.
  • Clone the git repo and run the following commands:
composer install
npm install
npm run dev

Note that the Vite Dev Server runs on port 3000. You access the website via the hostname and Vite will HMR or refresh automatically. If the Vite Dev Server is not running the website will pull it's assets from the /dist directory.

Important: You MUST set WP_ENVIRONMENT_TYPE to development or local in your wp-config.php file for the Vite Dev Server to work. Local by Flywheel does this automatically.

Features

  • TailwindCSS (v3.4)
  • Multilingual ready (WPML)
  • Responsive
  • General Options via ACF
    • Admin login screen logo
    • Custom Dashboard Widget
    • Social links
    • Sticky header menu
    • Client Data (Address, Telephone number, Email address, Company number)
    • Footer text
    • Alert Bar with top/bottom positions
    • Maintenance mode popup
    • Custom 404 page
  • Advanced Custom Fields
  • ACF JSON Folder
  • TypeScript
  • Vite build script
  • Vitest for testing Vue components
  • Cypress for Integration and E2E tests
  • Composer for PHP package management
  • Namespaced functions
  • Auto post type / slug based template routing
  • Shortcodes
  • SVG Sprite
  • Web Font Loader load Google, Typekit and custom fonts
  • VueJS v3.x with Composition API
  • Pinia State Management
  • Form support via Tofino Form Builder plugin
  • AjaxForm PHP Class
  • Fragment Cache PHP Class

Documentation

Docs are provided by README.md files in each directory.

Deployment

We use GitHub Actions. The deployment script is issued the following commands:

composer install
npm install
npm run build

The following files and directories should not be deployed on the server:

src
node_modules
.vscode
.editorconfig
.env
.eslintrc.cjs
.git
.github
.gitignore
.gitkeep
.git-ftp-ignore
.git-ftp-include
.gitattributes
.gitignore
.prettierignore
.npmrc
composer.json
composer.lock
package.json
package-lock.json
postcss.config.cts
tsconfig.json
vite.config.ts
phpcs.xml
\*.md
cypress
cypress.config.ts
prettier.config.cjs
stylelint.config.ts
tailwind.config.ts
vite.config.ts
vite-env.d.ts