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 >= 7.4.0 | php -v |
php.net |
| Node.js >= 14.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.
Features
- TailwindCSS(v3.0)
- Multilingual ready (WPML)
- Responsive
- Cypress testing framework
- 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
- Contact form and custom email templates
- Maintenance mode popup
- Custom 404 page
- Advanced Custom Fields
- ACF JSON Folder
- TypeScript
- Vite build script
- 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
- Contact Form with VeeValidate and Yup
- 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.js
.git
.github
.gitignore
.gitkeep
.git-ftp-ignore
.git-ftp-include
.gitattributes
.gitignore
.stylelintrc.js
.prettierrc.js
.prettierignore
.npmrc
composer.json
composer.lock
package.json
package-lock.json
postcss.config.js
tailwind.config.js
tsconfig.json
vite.config.js
phpcs.xml
*.md
cypress