{"id":22692897,"url":"https://github.com/cdk-comp/cdkage","last_synced_at":"2025-07-12T09:40:14.381Z","repository":{"id":62500439,"uuid":"143392042","full_name":"cdk-comp/cdkage","owner":"cdk-comp","description":"WordPress starter theme with a modern development workflow, based on Sage https://roots.io/sage/","archived":false,"fork":false,"pushed_at":"2018-10-02T21:02:34.000Z","size":270,"stargazers_count":4,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T18:08:11.224Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/cdk-comp.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}},"created_at":"2018-08-03T07:13:29.000Z","updated_at":"2022-12-18T18:38:52.000Z","dependencies_parsed_at":"2022-11-02T12:01:03.061Z","dependency_job_id":null,"html_url":"https://github.com/cdk-comp/cdkage","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdk-comp%2Fcdkage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdk-comp%2Fcdkage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdk-comp%2Fcdkage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdk-comp%2Fcdkage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cdk-comp","download_url":"https://codeload.github.com/cdk-comp/cdkage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248647297,"owners_count":21139086,"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":[],"created_at":"2024-12-10T02:08:25.403Z","updated_at":"2025-04-13T00:11:03.069Z","avatar_url":"https://github.com/cdk-comp.png","language":"PHP","funding_links":["https://www.paypal.me/cdkdev","https://www.buymeacoffee.com/cdk"],"categories":[],"sub_categories":[],"readme":"# [CDKage based Sage](https://roots.io/sage/)\n[![Packagist](https://img.shields.io/packagist/vpre/cdk-comp/cdkage.svg?style=flat-square)](https://packagist.org/packages/cdk-comp/cdkage)\n[![devDependency Status](https://img.shields.io/david/dev/cdk-comp/cdkage.svg?style=flat-square)](https://david-dm.org/cdk-comp/cdkage#info=devDependencies)\n[![Build Status](https://img.shields.io/travis/cdk-comp/cdkage.svg?style=flat-square)](https://travis-ci.org/cdk-comp/cdkage)\n\nCDKAGE is a Sage based WordPress starter theme with a modern development workflow.\n\n## Features\n\n* Sass for stylesheets\n* Modern JavaScript\n* [Webpack](https://webpack.github.io/) for compiling assets, optimizing images, and concatenating and minifying files\n* [Browsersync](http://www.browsersync.io/) for synchronized browser testing\n* [Blade](https://laravel.com/docs/5.6/blade) as a templating engine\n* [Controller](https://github.com/soberwp/controller) for passing data to Blade templates\n* [ACF](https://www.advancedcustomfields.com) support with custom modules development\n* [ACF Builder](https://github.com/StoutLogic/acf-builder) configuration arrays for Advanced Custom Fields Pro using the builder pattern and a fluent API\n* [Ultimate Fields](https://www.ultimate-fields.com/) support with custom modules development\n\nSee a working example at [roots-example-project.com](https://roots-example-project.com/).\n\n## Requirements\n\nMake sure all dependencies have been installed before moving on:\n\n* [WordPress](https://wordpress.org/) \u003e= 4.9.8\n* [Advanced Custom Fields](https://wordpress.org/plugins/advanced-custom-fields) \u003e= 5.7.6\n  or\n* [Ultimate Fields](https://wordpress.org/plugins/ultimate-fields) \u003e= 3.0.2\n* [PHP](https://secure.php.net/manual/en/install.php) \u003e= 7.1.3 (with [`php-mbstring`](https://secure.php.net/manual/en/book.mbstring.php) enabled)\n* [Composer](https://getcomposer.org/download/)\n* [Node.js](http://nodejs.org/) \u003e= 6.9.x\n* [Yarn](https://yarnpkg.com/en/docs/install)\n\n## Theme installation\n\nInstall CDKage using Composer from your WordPress themes directory (replace `your-theme-name` below with the name of your theme):\n\n```shell\n# @ app/themes/ or wp-content/themes/\n$ composer create-project cdk-comp/cdkage your-theme-name\n```\n\nTo install the latest development version of Sage, add `dev-master` to the end of the command:\n\n```shell\n$ composer create-project roots/sage your-theme-name dev-master\n```\n\nDuring theme installation you will have options to update `style.css` theme headers, select a CSS framework, and configure Browsersync.\n\n## Theme structure\n\n```shell\nthemes/your-theme-name/               # → Root of your Sage based theme\n├── app/                              # → Theme PHP\n│   ├── Controllers/                  # → Controller files\n│   ├── admin.php                     # → Theme customizer setup\n│   ├── filters.php                   # → Theme filters\n│   ├── helpers.php                   # → Helper functions\n│   ├── setup.php                     # → Theme setup\n│   ├── wcf-check.php                 # → Check if required plugin's exist\n│   ├── wcf-init.php                  # → Init option page for module management\n│   ├── wcf-modules.php               # → Module management for ACF/Ultimate fields\n│   └── setup.php                     # → Theme setup\n├── composer.json                     # → Autoloading for `app/` files\n├── composer.lock                     # → Composer lock file (never edit)\n├── dist/                             # → Built theme assets (never edit)\n├── node_modules/                     # → Node.js packages (never edit)\n├── package.json                      # → Node.js dependencies and scripts\n├── resources/                        # → Theme assets and templates\n│   ├── assets/                       # → Front-end assets\n│   │   ├── config.json               # → Settings for compiled assets\n│   │   ├── build/                    # → Webpack and ESLint config\n│   │   ├── fonts/                    # → Theme fonts\n│   │   ├── images/                   # → Theme images\n│   │   ├── scripts/                  # → Theme JS\n│   │   └── styles/                   # → Theme stylesheets\n│   ├── functions.php                 # → Composer autoloader, theme includes\n│   ├── index.php                     # → Never manually edit\n│   ├── modules/                      # → Module loads and config\n│   │   ├── **/fields.php             # → Fields management\n│   │   ├── **/partial.blade.php      # → Module template\n│   │   ├── **/script.js              # → Module JS\n│   │   ├── **/style.scss             # → Module stylesheets\n│   │   └── class-module-loader.php   # → Settings for compiled assets\n│   ├── screenshot.png                # → Theme screenshot for WP admin\n│   ├── style.css                     # → Theme meta information\n│   └── views/                        # → Theme templates\n│       ├── layouts/                  # → Base templates\n│       └── partials/                 # → Partial templates\n└── vendor/                           # → Composer packages (never edit)\n```\n\n## Theme setup\n\nEdit `app/setup.php` to enable or disable theme features, setup navigation menus, post thumbnail sizes, and sidebars.\n\n## Theme development\n\n* Run `yarn` from the theme directory to install dependencies\n* Update `resources/assets/config.json` settings:\n  * `devUrl` should reflect your local development hostname\n  * `publicPath` should reflect your WordPress folder structure (`/wp-content/themes/cdkage` for non-[Bedrock](https://roots.io/bedrock/) installs)\n\n### Build commands\n\n* `yarn start` — Compile assets when file changes are made, start Browsersync session\n* `yarn build` — Compile and optimize the files in your assets directory\n* `yarn build:production` — Compile assets for production\n\n## Documentation\n\n* [Sage documentation](https://roots.io/sage/docs/)\n* [Controller documentation](https://github.com/soberwp/controller#usage)\n* [Advanced Custom Fields](https://www.advancedcustomfields.com/resources/)\n* [ACF Builder](https://github.com/StoutLogic/acf-builder/wiki)\n* [Ultimate Fields](http://ultimate-fields.com/docs/)\n\n## Contributing\n\nContributions are welcome from everyone.\n\n## CDKage sponsors\n\nHelp support our open-source development efforts by:\n\n* Buy a [hosting](http://bit.ly/do_cdk) (and receive $10 credit!)\n* [PayPal donate](https://www.paypal.me/cdkdev)\n* Buy me a [coffee](https://www.buymeacoffee.com/cdk)\n\n## Community\n\n* Participate on the [Telegram](https://t.me/dimaminka)\n\nTODO\n==========\n- [ ] Make example project with cdk-comp/bedrock and vagrant-easyengine\n- [ ] Update dependencies for Node.js\n- [ ] Make ACF builder module\n- [ ] Include showcase screencast about a CDKage\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdk-comp%2Fcdkage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcdk-comp%2Fcdkage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdk-comp%2Fcdkage/lists"}