{"id":20604331,"url":"https://github.com/bymattlee/bymattlee-wp-starter-theme","last_synced_at":"2025-04-15T02:23:02.473Z","repository":{"id":25892109,"uuid":"61589991","full_name":"bymattlee/bymattlee-wp-starter-theme","owner":"bymattlee","description":"A starter boilerplate WordPress theme powered by Gulp, Tailwind CSS, rollup.js, Alpine.js and Highway.","archived":false,"fork":false,"pushed_at":"2023-06-22T05:42:03.000Z","size":2302,"stargazers_count":17,"open_issues_count":4,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T14:11:12.261Z","etag":null,"topics":["alphinejs","babel","boilerplate","browsersync","es6","gulp","highwayjs","js","modules","rollup","scss-files","starter-wordpress-theme","tailwindcss","utility-classes","wordpress","yarn"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bymattlee.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-06-21T00:34:04.000Z","updated_at":"2024-09-04T02:10:30.000Z","dependencies_parsed_at":"2024-11-16T09:32:56.920Z","dependency_job_id":null,"html_url":"https://github.com/bymattlee/bymattlee-wp-starter-theme","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bymattlee%2Fbymattlee-wp-starter-theme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bymattlee%2Fbymattlee-wp-starter-theme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bymattlee%2Fbymattlee-wp-starter-theme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bymattlee%2Fbymattlee-wp-starter-theme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bymattlee","download_url":"https://codeload.github.com/bymattlee/bymattlee-wp-starter-theme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248992052,"owners_count":21194991,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alphinejs","babel","boilerplate","browsersync","es6","gulp","highwayjs","js","modules","rollup","scss-files","starter-wordpress-theme","tailwindcss","utility-classes","wordpress","yarn"],"created_at":"2024-11-16T09:22:13.119Z","updated_at":"2025-04-15T02:23:02.453Z","avatar_url":"https://github.com/bymattlee.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![ByMattLee](http://hosted.bymattlee.com/github/bymattlee-logo.png)](http://bymattlee.com)\n\n# ByMattLee WP Starter Theme\n\nA starter boilerplate WordPress theme featuring [Gulp](https://gulpjs.com/), [Tailwind CSS](https://tailwindcss.com/), [rollup.js](https://rollupjs.org/), [Alpine.js](https://alpinejs.dev/) and [Taxi.js](https://taxi.js.org/).\n\n---\n\n## Installation\n\n##### 1. Install Node 16.17.1 LTS: \u003chttps://nodejs.org/\u003e\n\n##### 2. Install Yarn: \u003chttps://yarnpkg.com/\u003e\n\n##### 3. Install all dependencies\n\n```\n$ yarn\n```\n\n---\n\n## Configuration\n\n##### Update Gulp Config\n\nAll Gulp settings can be found in `gulpfile.babel.js/config.js`. To connect BrowserSync to the local development environment to enable browser reload, update `browserSync.proxy` to local development address.\n\n---\n\n## Use\n\n##### Build Files For Development And Initialize Watch\n\n```\n$ yarn dev\n```\n\n##### Build Files For Staging\n\n```\n$ yarn stage\n```\n\n##### Build Files For Production\n\n```\n$ yarn prod\n```\n\n---\n\n## General Features\n\n-   Features [Gulp](https://gulpjs.com/) as the build pipeline that compiles styles and scripts, and optimizes assets\n-   Browser reload when PHP, JS, image, SVG or asset files are updated\n-   Styles are injected when SCSS files are updated\n\n##### WordPress\n\n-   Includes base WordPress template files and optimized theme setup\n-   Advanced Custom Fields PRO plugin is recommended to create custom fields and Option pages. Default settings can be imported from `acf-global-options.json`\n\n##### Styles\n\n-   Features [Tailwind CSS](https://tailwindcss.com/), a utility-first framework\n-   Includes linter (Stylelint), autoprefixer, minification and sourcemap creation\n-   SCSS files are located in `assets/src/scss`\n-   `main.scss` in `assets/src/scss` serves as the base that includes the other dependent SASS files\n-   `main.scss` gets compiled to `assets/dist/css/main.min.css`\n-   `.stylelintrc` contains the settings for Stylelint\n-   Info about class namespacing can be found in `src/assets/scss/main.scss`\n-   Unused CSS (PurgeCSS) will be removed in staging and production builds\n\n##### Scripts\n\n-   Features [rollup.js](https://rollupjs.org/guide/en/) as the module bundler\n-   Includes linting (ESLint), concatenation, minification and sourcemap creation\n-   Includes [Taxi.js](https://taxi.js.org/) for seamless page transitions\n-   Includes a custom framework for reuseable content animations\n-   Includes [Alpine.js](https://alpinejs.dev/) for declarative DOM manipulation\n-   `main.js` in `src/assets/js` serves as the main JS file that includes and runs all components and will be compiled to `dist/assets/js/main.min.js`\n-   All local components should be placed in `src/assets/js/components`\n-   All vendor JS can be manually added to `src/assets/js/vendors` if not found on Yarn\n-   `.eslintrc` contains the settings for ESLint\n\n##### Images\n\n-   Place all unoptimized images in the `assets/src/images` directory\n-   They will then be optimized and placed in `assets/dist/images`\n\n##### SVGS\n\n-   Place all SVG files in the `assets/src/svg` directory\n-   They will then be optimized and added to a sprite at `assets/dist/svg/sprite.svg`\n\n##### Other Assets\n\n-   All assets (fonts, videos, swfs, etc) under `assets/src` will be copied to `assets/dist` on build\n\n---\n\n## Tailwind CSS Notes\n\n-   All Tailwind settings can be found in `./tailwind.config.js`\n-   Most styles should be written as utility classes in the template markup but custom SCSS can be used for unique properties and/or magic numbers\n-   Utilize the [`@apply`](https://tailwindcss.com/docs/functions-and-directives#apply) directive when writing custom SCSS for efficiency:\n\n```scss\nsvg {\n    @apply u-inline-block u-fill-current;\n}\n```\n\n-   Tailwind settings can be accessed with the [`theme()`](https://tailwindcss.com/docs/functions-and-directives#theme) function:\n\n```scss\n.button {\n    animation-duration: theme('transitionDuration.normal');\n}\n```\n\n-   Media queries can be used with the shorthand `screen()` function:\n\n```scss\n.button {\n    margin-right: 2.8rem;\n    @screen sm {\n        margin-right: 4.2rem;\n    }\n}\n```\n\n---\n\n## Contact\n\n-   Matt Lee - `@bymattlee` on most platforms\n-   Visit my website at [bymattlee.com](https://bymattlee.com)\n\n[![Twitter Follow](https://img.shields.io/twitter/follow/bymattlee?style=social)](https://twitter.com/bymattlee)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbymattlee%2Fbymattlee-wp-starter-theme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbymattlee%2Fbymattlee-wp-starter-theme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbymattlee%2Fbymattlee-wp-starter-theme/lists"}