PHPackages                             suomato/base-camp - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI &amp; Console](/categories/cli)
4. /
5. suomato/base-camp

ActiveWordpress-theme[CLI &amp; Console](/categories/cli)

suomato/base-camp
=================

Awesome WordPress starter theme with own CLI for developers based on modern web technologies.

v1.9.0(7y ago)14448921[1 issues](https://github.com/suomato/base-camp/issues)[20 PRs](https://github.com/suomato/base-camp/pulls)MITPHPPHP ^7.0

Since Aug 13Pushed 3y ago13 watchersCompare

[ Source](https://github.com/suomato/base-camp)[ Packagist](https://packagist.org/packages/suomato/base-camp)[ RSS](/packages/suomato-base-camp/feed)WikiDiscussions master Synced 2w ago

READMEChangelog (10)Dependencies (7)Versions (41)Used By (0)

[![](https://raw.githubusercontent.com/suomato/base-camp/develop/resources/assets/images/base-camp-logo.png)](https://raw.githubusercontent.com/suomato/base-camp/develop/resources/assets/images/base-camp-logo.png)

[![Dependency Status](https://camo.githubusercontent.com/0cdddf59597f403598065b24cb91c518fcfee411b2b8dc126422d8942df88ede/68747470733a2f2f706f7365722e707567782e6f72672f73756f6d61746f2f626173652d63616d702f762f737461626c652e737667)](https://packagist.org/packages/suomato/base-camp) [![Dependency Status](https://camo.githubusercontent.com/42a6b5184cfc1fff7a0595cb245e7904c9b43e15cfa6285f0af5226ea59a6cce/68747470733a2f2f706f7365722e707567782e6f72672f73756f6d61746f2f626173652d63616d702f762f756e737461626c652e737667)](https://packagist.org/packages/suomato/base-camp) [![License](https://camo.githubusercontent.com/e2d4041e36f6da0550b127ef2a69cee6af68f891d98197c3894e6d499822c088/68747470733a2f2f706f7365722e707567782e6f72672f73756f6d61746f2f626173652d63616d702f6c6963656e73652e737667)](https://packagist.org/packages/suomato/base-camp)

About Base Camp
---------------

[](#about-base-camp)

> Awesome WordPress starter theme with own CLI for developers based on modern web technologies.

Features
--------

[](#features)

- [Bulma](http://bulma.io/) (Responsive CSS framework based on Flexbox)
- [Timber](https://www.upstatement.com/timber/)
    - Twig Template Engine
    - Cleaner and better code
    - Separates the logic from presentation
- [Webpack](https://webpack.github.io/)
    - Sass / Scss for stylesheets (Minimize in production)
    - ES6 for Javascript (Minimize in production)
    - Automatic Cache Busting
    - Split javascript code to two chunks, app.js and vendor.js
    - [Vuejs](https://vuejs.org/) for boosting frontend development
    - [BrowserSync](https://www.browsersync.io/) for synchronised browser testing
- [Luna](https://github.com/suomato/luna) (Command-line interface included with Base Camp)
- [WooCommerce](https://woocommerce.com/) support with basic boilerplate.

Requirements
------------

[](#requirements)

- [Wordpress](https://wordpress.org/) &gt;= v4.9.6
- [Composer](https://getcomposer.org/download/) &gt;= v1.6.5
- [PHP](http://php.net/manual/en/install.php) &gt;= v7.0
- [Yarn](https://yarnpkg.com/en/) &gt;= v1.7.0 **or** [npm](https://www.npmjs.com/) &gt;= v6.1.0
- [Nodejs](https://nodejs.org/en/) &gt;= v8.11.1

Installation
------------

[](#installation)

- Go your themes folder and run`composer create-project suomato/base-camp`
- `cd base-camp`
- `yarn` **or** `npm install`
- define your custom webpack config to `build/config.js` file
- `yarn watch` **or** `npm run watch`
- Happy developing :)

Structure
---------

[](#structure)

```
base-camp/                                          # Theme root
├── app/                                            # Theme logic
│   ├── config/                                     # Theme config
│   │   ├── wp/                                     # WordPress specific config
│   │   │   ├── admin-page.php                      # Register here WordPress Admin Page config
│   │   │   ├── image-sizes.php                     # Register here WordPress Custom image sizes
│   │   │   ├── login-page.php                      # Register here WordPress Login Page config
│   │   │   ├── maintenance.php                     # Maintenance mode config
│   │   │   ├── menus.php                           # Register here WordPress navigation menus
│   │   │   ├── scripts-and-styles.php              # Register here WordPress scripts and styles
│   │   │   ├── security.php                        # Things that increase the site security
│   │   │   ├── sidebars.php                        # Register here WordPress sidebars
│   │   │   └── theme-supports.php                  # Register here WordPress theme features
│   │   ├── autoload.php                            # Includes all config files (DON'T REMOVE THIS)
│   │   ├── timber.php                              # Timber specific config
│   │   └── woocommerce.php                         # Init woocommerce support
│   ├── models/                                     # Wrappers for Timber Classes
│   ├── timber-extends/                             # Extended Timber Classes
│   │   └── BaseCampSite.php                        # Extended TimberSite Class
│   ├── bootstrap.php                               # Bootstrap theme
│   ├── helpers.php                                 # Common helper functions
├── build/                                          # Theme assets and views
│   ├── config.js                                   # Custom webpack config
│   ├── webpack.config.js                           # Webpack config
├── resources/                                      # Theme assets and views
│   ├── assets/                                     # Front-end assets
│   │   ├── js/                                     # Javascripts
│   │   │   └── components/                         # Vue Components
│   │   ├── sass/                                   # Styles
│   │   │   └── components/                         # Partials
│   ├── languages/                                  # Language features
│   │   ├── base-camp.pot                           # Template for translation
│   │   └── messages.php                            # Language strings
│   ├── views/                                      # Theme Twig files
│   │   ├── components/                             # Partials
│   │   ├── footer/                                 # Theme footer templates
│   │   └── header/                                 # Theme header templates

```

Models
------

[](#models)

> Models are wrapper classes for Wordpress Post Types and Taxonomies. They provide very simple interface to interact with the database.

### How to use

[](#how-to-use)

```
// index.php
