https://github.com/10degrees/10degrees-base

Base theme for 10 Degrees WordPress projects
https://github.com/10degrees/10degrees-base

laravel-mix php wordpress wordpress-theme

Last synced: 3 months ago
JSON representation

Base theme for 10 Degrees WordPress projects

• Host: GitHub
• URL: https://github.com/10degrees/10degrees-base
• Owner: 10degrees
• Created: 2019-08-23T09:23:50.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-07T01:44:23.000Z (over 1 year ago)
• Last Synced: 2024-07-31T01:46:31.735Z (4 months ago)
• Topics: laravel-mix, php, wordpress, wordpress-theme
• Language: PHP
• Homepage:
• Size: 17.9 MB
• Stars: 4
• Watchers: 5
• Forks: 2
• Open Issues: 26
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
 

# 10 Degrees base WordPress theme

The 10 Degrees base WordPress theme is intended as a quick-start for developers and requires configuration before using. It uses a number of concepts from Laravel, and aims to make development more standardised and accessible. Where possible, [PSR-2](https://www.php-fig.org/psr/psr-2/) style guidelines are mandated with a custom ruleset.

* CSS: SASS preprocessor for CSS

* JavaScript: ES6 ready

* PHP: Namespaces and autoloader with many asbtractions and helper functions

* PHP: [base.php](base.php) wrapper, originally implemented by [Sage theme](https://roots.io/sage/)

* WP CLI block quickstart command

## Requirements

* WordPress >= 5.6

* PHP >= 7.0

* Composer

* Node

Dependencies are managed through [Composer](https://getcomposer.org/) and [Node](https://nodejs.org). Please ensure both are installed.

## Installation

### Via Composer

1) Add `"10degrees/10degrees-base": "*"` to the `require` section of your site-wide `composer.json`.

2) Run `composer install`.

### Manual install

1) Download the latest theme release from https://github.com/10degrees/10degrees-base/releases/latest.

2) Upload zip file to Appearance -> Themes.

## Theme Setup

From the theme root folder, run:

* `composer install` 

    * this will already have run if you have added `10degrees/10degrees-base` as part of a site-wide composer-based install. For 10 Degrees developers, this is already included as part of our `10degrees-alpha` master install.

* `npm install`

### Placeholders

Find and replace `@textdomain` and `@theme` placeholders in order to set the theme's text domain and name as required.

## Compiling assets

Assets are edited in `src` and compiled to `dist`. Files are given a cache-busting version when compiled for production only. Use `npm run watch` and `npm run dev` when compiling for development. Use `npm run production` when compiling for production.

## Browser support

All modern browsers.