https://github.com/philwareham/textpattern-material-components-web

Textpattern templates based on Google’s Material Components for the Web framework.
https://github.com/philwareham/textpattern-material-components-web

framework material material-design textpattern textpattern-templates theme

Last synced: 30 days ago
JSON representation

Textpattern templates based on Google’s Material Components for the Web framework.

• Host: GitHub
• URL: https://github.com/philwareham/textpattern-material-components-web
• Owner: philwareham
• Created: 2016-01-12T09:21:04.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T04:55:11.000Z (about 2 years ago)
• Last Synced: 2024-04-14T19:30:33.750Z (10 months ago)
• Topics: framework, material, material-design, textpattern, textpattern-templates, theme
• Language: HTML
• Homepage:
• Size: 13.2 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 31
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Textpattern Material Components for the Web Templates

[![Greenkeeper](https://badges.greenkeeper.io/philwareham/textpattern-material-components-web.svg)](https://greenkeeper.io/)

[![Build Status](https://travis-ci.org/philwareham/textpattern-material-components-web/master.svg)](https://travis-ci.org/philwareham/textpattern-material-components-web)

[Demo](http://material-components-web.philwareham.co.uk/).

Textpattern templates for use with [Material Components for the Web](https://material.io/components/web/).

## Supported web browsers

* Internet Explorer 11.

* Chrome, Edge, Firefox, Safari and Opera the last two recent stable releases.

## Requirements

Building this repository requires:

* [Node.js](https://nodejs.org/)

* [Grunt](https://gruntjs.com/)

## Setup

### Installing required tools

The project uses [Grunt](https://gruntjs.com/) to run tasks and [Sass](http://sass-lang.com/) for CSS pre-processing. First make sure you have base dependencies installed: [Node.js](https://nodejs.org/) and [Grunt](https://gruntjs.com/). You can install Node using the [installer](https://nodejs.org/) and Grunt with npm:

```ShellSession

$ npm install -g grunt-cli

```

Consult the Grunt documentation for more instructions if necessary. You might need to use `sudo npm install -g grunt-cli` instead when installing on certain Unix-based systems.

### Installing dependencies

After you have the base dependencies taken care of, you can install the project's dependencies. Navigate to the project's directory, and run the dependency manager:

```ShellSession

$ cd textpattern-material-design-lite

$ npm install

```

**npm** installs Node modules for Grunt. You might need to use `sudo npm install` instead when installing on certain Unix-based systems (you can also install via Yarn, instead of npm).

## Building

This repository hosts sources and needs to be built before it can be used. After you have installed all dependencies, you will be able to run tasks using Grunt, including building:

```ShellSession

$ grunt @task@

```

Where the `@task@` is either `build` or `watch`.

* The `build` task builds the project.

* The `watch` task will launch a task that watches for file changes; the project is then automatically built if a source file is modified.

## Updating Material Components for the Web

If you'd like to upgrade to a newer version of Material Components for the Web down the road just run:

```ShellSession

$ npm update

```

## Textpattern templates

*Currently under development.*

## License

Licensed under Apache-2 license except Textpattern templates, which are licensed under GPLv2 license.