https://github.com/tomodomoco/starter-wp

An immensely opinionated starter framework for WordPress builds
https://github.com/tomodomoco/starter-wp

template

Last synced: 9 days ago
JSON representation

An immensely opinionated starter framework for WordPress builds

• Host: GitHub
• URL: https://github.com/tomodomoco/starter-wp
• Owner: TomodomoCo
• License: mit
• Created: 2012-06-22T14:12:09.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T19:01:13.000Z (almost 2 years ago)
• Last Synced: 2024-04-14T23:59:29.585Z (7 months ago)
• Topics: template
• Language: PHP
• Homepage: https://tomodomo.co/
• Size: 1.36 MB
• Stars: 28
• Watchers: 5
• Forks: 3
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# starter-wp

A highly opinionated starter framework for WordPress.

Leverages [Kaiso](https://github.com/TomodomoCo/kaiso) and [Timber](https://github.com/timber/timber) for a more modern, concern-separated approach to WordPress development. Installs [psalm](https://github.com/vimeo/psalm) and [phpcs](https://github.com/squizlabs/PHP_CodeSniffer) for linting and static analysis. Uses [gulp](https://github.com/gulpjs/gulp) as a front-end build system.

## Usage

Vagrant setup:

1. `git clone [repo]`

2. `cp -r app/secrets-example app/secrets`

3. Fill out files in `app/secrets/`

4. `vagrant up`

Building the project:

1. `composer install`

2. `nvm install && nvm use`

3. `npm install`

4. `npm run dev` or `npm run build`

Linting:

+ `npm run lint-php` for both `phpcs` and `psalm`

+ `npm run phpcs` or `./vendor/composer/bin/phpcs`

+ `npm run psalm` or `./vendor/composer/bin/psalm`

Building plugin dependencies (e.g. for Gutenberg blocks):

1. `npm run lerna-install`

2. `npm run lerna-dev` or `npm run lerna-build`

## About Tomodomo

Tomodomo is a creative agency for magazine publishers. We use custom design and technology to speed up your editorial workflow, engage your readers, and build sustainable subscription revenue for your business.

Learn more at [tomodomo.co](https://tomodomo.co) or email us: [[email protected]](mailto:[email protected])

## License

© 2018 Van Patten Media Inc. d/b/a Tomodomo.

This project is licensed under the terms of the MIT License, included in `LICENSE.md`.

## Code of Conduct

All open source Tomodomo projects follow a strict code of conduct, included in `CODEOFCONDUCT.md`. We ask that all contributors adhere to the standards and guidelines in that document.

Thank you!