├── .gitignore ├── boilerplate.yaml ├── blank-src ├── version.yaml ├── index.js ├── assets │ ├── css │ │ ├── theme.pcss │ │ └── entry.pcss │ ├── images │ │ └── october.png │ └── javascript │ │ └── app.js ├── new-theme.yaml ├── theme.yaml ├── partials │ └── site │ │ └── footer.htm ├── pages │ ├── 404.htm │ ├── error.htm │ └── home.htm ├── postcss.config.js ├── tailwind.config.js ├── package.json └── layouts │ └── default.htm ├── assets └── images │ └── theme-preview.png ├── theme.yaml ├── custom_loaders └── theme-filter-loader.js ├── version.yaml ├── package.json ├── webpack.config.js ├── modules └── html-parser.js ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | -------------------------------------------------------------------------------- /boilerplate.yaml: -------------------------------------------------------------------------------- 1 | themeName: blank 2 | -------------------------------------------------------------------------------- /blank-src/version.yaml: -------------------------------------------------------------------------------- 1 | 1.0.0: Theme initialization 2 | -------------------------------------------------------------------------------- /blank-src/index.js: -------------------------------------------------------------------------------- 1 | import './assets/javascript/app.js' 2 | import './assets/css/entry.pcss' 3 | -------------------------------------------------------------------------------- /blank-src/assets/css/theme.pcss: -------------------------------------------------------------------------------- 1 | /* Custom css should be typed here if needed */ 2 | body 3 | color: red 4 | -------------------------------------------------------------------------------- /assets/images/theme-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RomainMazB/octobercms-tailwindcss-boilerplate/HEAD/assets/images/theme-preview.png -------------------------------------------------------------------------------- /blank-src/assets/images/october.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RomainMazB/octobercms-tailwindcss-boilerplate/HEAD/blank-src/assets/images/october.png -------------------------------------------------------------------------------- /blank-src/new-theme.yaml: -------------------------------------------------------------------------------- 1 | name: Blank Theme 2 | description: A dummy theme 3 | author: Romain ''Maz'' B 4 | homepage: https://www.octobercms.fr 5 | code: 'blank' 6 | -------------------------------------------------------------------------------- /blank-src/theme.yaml: -------------------------------------------------------------------------------- 1 | name: (Source)Blank Theme 2 | description: A dummy theme 3 | author: Romain ''Maz'' B 4 | homepage: https://www.octobercms.fr 5 | code: 'blank-src' 6 | -------------------------------------------------------------------------------- /blank-src/assets/javascript/app.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Needed for October's framework 3 | */ 4 | window.jQuery = require('jquery') 5 | 6 | /* 7 | * Application 8 | */ 9 | 10 | -------------------------------------------------------------------------------- /blank-src/partials/site/footer.htm: -------------------------------------------------------------------------------- 1 | 7 | -------------------------------------------------------------------------------- /blank-src/pages/404.htm: -------------------------------------------------------------------------------- 1 | title = "Page not found (404)" 2 | url = "/404" 3 | layout = "default" 4 | == 5 |
6 |
7 |

Page not found

8 |

We're sorry, but the page you requested cannot be found.

9 |
10 |
-------------------------------------------------------------------------------- /blank-src/assets/css/entry.pcss: -------------------------------------------------------------------------------- 1 | /*! purgecss start ignore */ 2 | @import "tailwindcss/base.css" 3 | @import "tailwindcss/components.css" 4 | @import "froala-editor/css/froala_style.min.css" 5 | /*! purgecss end ignore */ 6 | 7 | @import "./theme.pcss" 8 | 9 | @import "tailwindcss/utilities.css" 10 | -------------------------------------------------------------------------------- /blank-src/pages/error.htm: -------------------------------------------------------------------------------- 1 | title = "Error page (500)" 2 | url = "/error" 3 | layout = "default" 4 | == 5 |
6 |
7 |

Error

8 |

We're sorry, but something went wrong and the page cannot be displayed.

9 |
10 |
-------------------------------------------------------------------------------- /theme.yaml: -------------------------------------------------------------------------------- 1 | name: 'TailwindCSS Boilerplate' 2 | description: 'TailwindCSS with Webpack, PostCSS and PurgeCSS pre-configured for OctoberCMS to quickly create awesome themes.' 3 | author: "Romain 'Maz' B" 4 | homepage: https://www.octobercms.fr 5 | code: 'TailwindCSSBoilerplate' 6 | require: 7 | - RomainMazB.TailwindBoilerplate 8 | -------------------------------------------------------------------------------- /blank-src/postcss.config.js: -------------------------------------------------------------------------------- 1 | let path = require('path') 2 | 3 | module.exports = { 4 | 'parser': 'sugarss', 5 | 'plugins': [ 6 | require('postcss-import'), 7 | require('tailwindcss')(path.join(__dirname, './tailwind.config.js')), 8 | require('postcss-apply'), 9 | require('postcss-nested'), 10 | // 'postcss-custom-properties', 11 | require('autoprefixer') 12 | ] 13 | } 14 | -------------------------------------------------------------------------------- /blank-src/tailwind.config.js: -------------------------------------------------------------------------------- 1 | let glob = require('glob'), 2 | path = require('path') 3 | 4 | module.exports = { 5 | purge: glob.sync(path.join(__dirname, '**/*.htm')), 6 | theme: { 7 | extend: {}, 8 | }, 9 | variants: {}, 10 | plugins: [ 11 | require('@tailwindcss/typography'), 12 | require('@tailwindcss/aspect-ratio'), 13 | require('@tailwindcss/forms'), 14 | ], 15 | } 16 | -------------------------------------------------------------------------------- /custom_loaders/theme-filter-loader.js: -------------------------------------------------------------------------------- 1 | let path = require('path'), 2 | fs = require('fs'), 3 | loaderUtils = require('loader-utils') 4 | themeRegex = /\{\{[\s?]*["|'|`](.*[\.[webp|png|jpe?g|gif|ico])["|'|`][\s?]*\|[\s?]*theme[\s?]*\}\}/g; 5 | 6 | module.exports = function (content, map, meta) { 7 | let options = loaderUtils.getOptions(this) 8 | if (content.match(themeRegex)) { 9 | let parts; 10 | while ((parts = themeRegex.exec(content)) !== null) { 11 | let fullPath = path.join(options.from, parts[1]), 12 | file = fs.readFileSync(fullPath) 13 | this.emitFile(parts[1], file) 14 | } 15 | } 16 | 17 | return 'module.exports = [\n' + 18 | JSON.stringify(content) + 19 | '\n].join();' 20 | } 21 | 22 | -------------------------------------------------------------------------------- /version.yaml: -------------------------------------------------------------------------------- 1 | 1.0.1: 2 | - Theme initialization 3 | - Before use PLEASE READ the SPECIFIC UPDATES INSTRUCTIONS in Readme file 4 | 1.0.2: 5 | - Fix no such file 'assets/javascript/theme.js' issue 6 | - Modified file custom_loaders/theme-filter-loader.js 7 | 1.0.3: 8 | - Fix issue which didn't copy all the files 9 | - Modified file custom_loaders/theme-filter-loader.js 10 | 1.0.4: 11 | - Fix typo causing error 404 on theme.js in the layout import 12 | - Modified file src/layouts/default.htm 13 | 1.1.0: 14 | - Major release!! You do not have to watch the modified files anymore. 15 | - !!!! PLEASE READ THE NEW USE INSTRUCTIONS !!!! 16 | 1.1.1: Bump tailwindcss to ^1.4.5 17 | 1.1.2: Fix boilerplate's plugin dependency 18 | 1.2.0: 19 | - Move PurgeCSS to the new TailwindCSS Built-in process 20 | - Bump tailwindcss to ^1.4.6 21 | - Clean unused packages 22 | - Add more friendly errors 23 | 1.3.0: 24 | - Upgrade to TailwindCSS 2 and PostCSS8 25 | - Add tailwindcss forms, aspect-ratio and forms as default plugins 26 | - Cleanup packages 27 | 1.3.1: 28 | - Added support for multi-filters like {{ 'my-image.jpg'|theme|resize(30) }} 29 | - Added APP_PORT config from .env file 30 | 1.3.2: 31 | - Update blank-src packages 32 | 1.3.3: 33 | - Fix ternary operator in twig markup and html markup in PHP section 34 | 1.3.4: 35 | - Fix 'No HTML was found' error when a folder is empty 36 | -------------------------------------------------------------------------------- /blank-src/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "blank-src-theme", 3 | "version": "1.4.0", 4 | "description": "The perfect TailwindCSS boilerplate for theme creation on OctoberCMS", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "build": "webpack --mode=production", 9 | "debug": "webpack --mode=production --verbose", 10 | "watch": "webpack --watch --mode=development" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "octobercms/themes/tailwindcss-boilerplate" 15 | }, 16 | "keywords": [ 17 | "TailwindCSS", 18 | "OctoberCMS", 19 | "Theme", 20 | "Boilerplate", 21 | "Design", 22 | "Tool", 23 | "Webpack" 24 | ], 25 | "author": "Romain 'Maz' BILLOIR", 26 | "license": "ISC", 27 | "devDependencies": { 28 | "autoprefixer": "^10.2.6", 29 | "froala-editor": "^3.2.7", 30 | "jquery": "^3.6.0", 31 | "postcss": "^8.3.0", 32 | "postcss-apply": "^0.12.0", 33 | "postcss-import": "^14.0.2", 34 | "postcss-loader": "^5.3.0", 35 | "postcss-nested": "^5.0.5", 36 | "postcss-url": "^10.1.3", 37 | "sugarss": "^3.0.3", 38 | "tailwindcss": "^2.1.2", 39 | "@tailwindcss/typography": "^0.4.1", 40 | "@tailwindcss/forms": "^0.3.2", 41 | "@tailwindcss/aspect-ratio": "^0.2.1" 42 | }, 43 | "dependencies": {} 44 | } 45 | -------------------------------------------------------------------------------- /blank-src/layouts/default.htm: -------------------------------------------------------------------------------- 1 | description = "Default layout" 2 | == 3 | 4 | 5 | 6 | 7 | 8 | October CMS - {{ this.page.title }} 9 | 10 | 11 | 12 | 13 | 14 | 15 | {% styles %} 16 | 17 | 18 | 19 |
20 |
21 |
22 | 23 | 24 |
25 | {% page %} 26 |
27 | 28 | 29 | 32 |
33 |
34 |
35 | 36 | 37 | 38 | {% framework extras %} 39 | {% scripts %} 40 | 41 | 42 | 43 | 44 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "tailwindcss-boilerplate", 3 | "version": "1.1.1", 4 | "description": "The perfect TailwindCSS boilerplate for theme creation on OctoberCMS", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1", 8 | "build": "NODE_ENV='production' webpack -p", 9 | "debug": "NODE_ENV='production' webpack -p --verbose", 10 | "watch": "webpack --watch --mode=development" 11 | }, 12 | "repository": { 13 | "type": "git", 14 | "url": "octobercms/themes/tailwindcss-boilerplate" 15 | }, 16 | "keywords": [ 17 | "TailwindCSS", 18 | "OctoberCMS", 19 | "Theme", 20 | "Boilerplate", 21 | "Design", 22 | "Tool", 23 | "Webpack" 24 | ], 25 | "author": "Romain 'Maz' BILLOIR", 26 | "license": "ISC", 27 | "devDependencies": { 28 | "browser-sync": "^2.26.13", 29 | "browser-sync-webpack-plugin": "^2.3.0", 30 | "clean-webpack-plugin": "^3.0.0", 31 | "copy-webpack-plugin": "^5.1.2", 32 | "css-loader": "^3.6.0", 33 | "cssnano-webpack-plugin": "^1.0.3", 34 | "dotenv": "^8.2.0", 35 | "file-loader": "^5.1.0", 36 | "html-webpack-plugin": "^3.2.0", 37 | "js-yaml": "^3.14.1", 38 | "mini-css-extract-plugin": "^0.8.2", 39 | "postcss-loader": "^4.1.0", 40 | "sugarss": "^3.0.3", 41 | "terser-webpack-plugin": "^2.3.8", 42 | "url-loader": "^3.0.0", 43 | "webpack": "^4.44.2", 44 | "webpack-cli": "^3.3.12" 45 | }, 46 | "dependencies": {} 47 | } 48 | -------------------------------------------------------------------------------- /webpack.config.js: -------------------------------------------------------------------------------- 1 | /* Required packages */ 2 | require('dotenv').config({path: __dirname + '/./../../.env'}) 3 | 4 | let path = require('path'), 5 | webpack = require('webpack'), 6 | browserSyncPlugin = require('browser-sync-webpack-plugin'), 7 | miniCSSExtractPlugin = require('mini-css-extract-plugin'), 8 | {CleanWebpackPlugin} = require('clean-webpack-plugin'), 9 | copyPlugin = require('copy-webpack-plugin'), 10 | fs = require('fs'), 11 | yaml = require('js-yaml'), 12 | CssnanoPlugin = require('cssnano-webpack-plugin'), 13 | htmlParser = require('./modules/html-parser.js'), 14 | TerserPlugin = require('terser-webpack-plugin') 15 | 16 | async function config() 17 | { 18 | // Generate the new theme path folder form boilerplate.yaml 19 | let themeConfig = fs.readFileSync(path.join(__dirname, 'boilerplate.yaml'), 'utf8'), 20 | data = yaml.safeLoad(themeConfig), 21 | from = path.resolve(`../${data.themeName}-src`), 22 | to = path.resolve(`../${data.themeName}`), 23 | publicPath = path.join('themes', data.themeName), 24 | appPort = process.env.APP_PORT ?? '80', 25 | proxy = `${process.env.APP_URL}:${appPort}` 26 | 27 | let HTMLPlugins = await htmlParser(from, to, ['htm', 'html', 'txt']) 28 | 29 | let filesToCopy = [{from: path.join(from, 'new-theme.yaml'), to: path.join(to, 'theme.yaml')}, {from: path.join(from, 'version.yaml')}] 30 | let pathToThemePreviewFile = path.join(from, 'assets/images/theme-preview.png') 31 | if (fs.existsSync(pathToThemePreviewFile)) { 32 | filesToCopy.push({from: pathToThemePreviewFile}) 33 | } 34 | let pathToThemeConfigDir = path.join(from, 'config') 35 | if (fs.existsSync(pathToThemeConfigDir)) { 36 | filesToCopy.push({from: pathToThemeConfigDir, to: 'config'}) 37 | } 38 | 39 | return { 40 | entry: { 41 | context: from, 42 | }, 43 | output: { 44 | filename: 'assets/javascript/theme.js', 45 | path: to, 46 | publicPath: publicPath 47 | }, 48 | resolveLoader: { 49 | modules: ['node_modules', 'custom_loaders'] 50 | }, 51 | plugins: [ 52 | new webpack.ProgressPlugin(), 53 | new browserSyncPlugin({ 54 | host: 'localhost', 55 | port: 3000, 56 | proxy 57 | }), 58 | new miniCSSExtractPlugin({ 59 | filename: 'assets/css/theme.css', 60 | chunkFilename: '[id]-[hash].css', 61 | }), 62 | ... process.env.NODE_ENV === 'production' ? [ 63 | new CleanWebpackPlugin() 64 | ] : [], 65 | new copyPlugin(filesToCopy, {copyUnmodified: true}) 66 | ].concat(HTMLPlugins), 67 | module: { 68 | rules: [{ 69 | test: /\.p?css$/, 70 | use: [ miniCSSExtractPlugin.loader, 'css-loader', 'postcss-loader' ], 71 | },{ 72 | test: /\.(woff(2)?|ttf|eot|svg)(\?v=\d+\.\d+\.\d+)?$/, 73 | loader: 'file-loader', 74 | options: { 75 | name: '[name].[ext]', 76 | outputPath: (url, resourcePath, context) => path.relative(from, resourcePath) 77 | } 78 | },{ 79 | test: /\.(webp|png|jpe?g|gif|svg|ico)$/i, 80 | loader: 'file-loader', 81 | options: { 82 | name: '[name].[ext]', 83 | outputPath: (url, resourcePath, context) => path.relative(from, resourcePath) 84 | } 85 | },{ 86 | test: /\.(html?|txt)$/i, 87 | loader: 'theme-filter-loader', 88 | options: { 89 | from: from 90 | } 91 | }], 92 | }, 93 | optimization: { 94 | minimizer: [ 95 | new CssnanoPlugin(), 96 | new TerserPlugin() 97 | ] 98 | } 99 | } 100 | } 101 | 102 | module.exports = config(); 103 | 104 | -------------------------------------------------------------------------------- /modules/html-parser.js: -------------------------------------------------------------------------------- 1 | let HTMLWebpackPlugin = require('html-webpack-plugin'), 2 | fs = require('fs'), 3 | path = require('path') 4 | 5 | /** 6 | * Explores recursively a directory and returns all the file paths and folder paths in the callback. 7 | * 8 | * @base from http://stackoverflow.com/a/5827895/4241030 9 | * @param {String} rootDir 10 | * @param {String} to 11 | * @param {String} dir 12 | * @param {string[]} ext 13 | * @param {Function} done 14 | * @return {Promise} 15 | */ 16 | function htmlParser(rootDir, to, ext, done = addHTMLWebpackObject, dir = rootDir) 17 | { 18 | let results = [], 19 | dirs_to_ignore = [path.join(rootDir, 'node_modules'), path.join(rootDir, '.git')] 20 | 21 | return new Promise((resolve, reject) => { 22 | fs.readdir(dir, function (err, list) { 23 | if (err) { 24 | reject(err); 25 | } 26 | 27 | let pending = list.length; 28 | 29 | if (!pending) { 30 | return done(null, results, to); 31 | } 32 | 33 | list.forEach(async function (file) { 34 | if (dirs_to_ignore.includes(dir)) { 35 | // If last file to check 36 | if (!--pending) { 37 | resolve(await done(null, results, to)); 38 | } 39 | } 40 | else { 41 | file = path.resolve(dir, file); 42 | fs.stat(file, async function (err, stat) { 43 | // If directory, execute a recursive call 44 | if (stat && stat.isDirectory()) { 45 | await htmlParser(rootDir, to, ext, async function (err, res) { 46 | results = results.concat(res); 47 | if (!--pending) { 48 | resolve(await done(null, results, to)); 49 | } 50 | }, file); 51 | } else { 52 | // If extension matches 53 | if (ext.includes(path.extname(file).substring(1))) { 54 | results.push({ 55 | output_filename: path.relative(rootDir, file), 56 | template: file 57 | }); 58 | } 59 | // If last file to check 60 | if (!--pending) { 61 | resolve(await done(null, results, to)); 62 | } 63 | } 64 | }); 65 | } 66 | }); 67 | }); 68 | }); 69 | } 70 | 71 | /** 72 | * Create new HTML Webpack Objects from an array of input/output path 73 | * 74 | * @param {String} err 75 | * @param {Object} data 76 | * @param {String} to 77 | * @return {Promise} 78 | */ 79 | function addHTMLWebpackObject(err, data = null, to = null) 80 | { 81 | if (!data.length) { 82 | throw new Error("\r\n========\r\nTailwindCSS Boilerplate\r\nNo HTML was found in your theme-src directory.\r\n========") 83 | } 84 | 85 | let results = []; 86 | return new Promise((resolve, reject) => { 87 | if (err) { 88 | reject(err); 89 | } 90 | 91 | data.forEach((HTMLElement, key, data) => { 92 | results.push( 93 | new HTMLWebpackPlugin({ 94 | filename: to + "/" + HTMLElement.output_filename, 95 | template: HTMLElement.template, 96 | inject: false, 97 | minify: process.env.NODE_ENV === 'production' ? { 98 | collapseWhitespace: true, 99 | keepClosingSlash: true, 100 | removeComments: true, 101 | removeRedundantAttributes: true, 102 | removeScriptTypeAttributes: true, 103 | removeStyleLinkTypeAttributes: true, 104 | useShortDoctype: false, 105 | ignoreCustomFragments: [/(.*\n)*==(\n)*Display content 12 | TailwindCSS, Webpack and PostCSS is already installed and pre-configured to work together. 13 | Each configuration file is pre-built but customizable directly from your theme directory. 14 | 15 | This boilerplate comes with webpack and fully customised `webpack.config.js` file for OctoberCMS to manage all your assets: css, javascript, images, fonts and also all your template files: **Webpack will walk through all your directories and subdirectories** presents in your theme folder to compile the .htm, .html and .txt files to catch all the assets dependencies you may have added in them! 16 | 17 | PostCSS is the prepocessor of this boilerplate with the most used plugins. Feel free to add the plugins you want into the `postcss.config.js` 18 | 19 | 20 | ### PurgeCSS & Minification 21 |
Display content 22 | To ensure the optimization of your final theme: the `npm run build` process will remove all unused CSS with PurgeCSS, and all the JS and CSS files will be minified. 23 | Be aware that to not slow down the watch process, the purge and minification happen only on the `npm run build` process 24 |
25 | 26 | ### Auto-clean of previous build 27 |
Display content 28 | This boilerplate uses `clean-webpack-plugin` to ensure you don't have any useless files in your theme folder. Your files is cleaned only on the build process not to slow down the hot reload module. 29 |
30 | 31 | How to use 32 | ========== 33 | 34 | **The theme is not prebuilt, when installed. You may see some errors: it's a normal behavior, I wanted from you to understand how to build before actually use and customize it. 35 | You have to build it before see it.** 36 | 37 | #### .env file needed 38 | First of all: if it's not already the case, be sure to run `php artisan october:env`, it will create an .env file at the root of your project folder. 39 | 40 | Webpack will use `APP_URL` inside of it to serve the local server with BrowserSync and to correctly sets the paths of the assets. Be sure that it's correctly defined: 41 | ```dotenv 42 | APP_URL=http://dummy.test 43 | 44 | # OPTIONAL: Defaults to 80, you may use a custom local port: 45 | APP_PORT=8000 46 | ``` 47 | 48 | #### Configure the new Blank theme 49 | The Boilerplate comes with a blank theme in the `blank-src` folder, and use the `boilerplate.yaml` configuration file to create the final theme directory. 50 | Copy the `blank-src` directory to the October's `themes` one. 51 | 52 | In the `blank-src`: you can see a `theme.yaml`: this it the one for the *Source theme*, and the `new-theme.yaml` is the one for... the new theme, obviously. 53 | It will be renamed on watch/build process, the two files are needed to differenciate them from the backend. 54 | 55 | *As long as you modify the theme name in the boilerplate.yaml, you are free to name the new theme as you want. 56 | Eg: in `boilerplate.yaml` you can put the `themeName` to `awesome-theme` and create a `awesome-theme-src` folder which will be the `src` directory for your new theme. 57 | The boilerplate will generate the `awesome-theme` in the October's `themes` folder.* 58 | 59 | #### NPM 60 | Again, this theme is not a theme, it's a toolkit, based on NPM. To use it, be sure to have [node](https://github.com/nodejs/node) and [npm](https://github.com/npm/cli) installed on your machine. 61 | 62 | Then, follow this quick steps: 63 | 64 | 1. Launch a terminal from the `romainmazb-tailwindcss-boilerplate` directory 65 | 2. Run `npm install` to install **the boilerplate dependencies**. 66 | 3. Then go to the `blank-src` directory and launch again `npm install`, this will install **your theme dependencies**, for now just the ones required by October, PostCSS and TailwindCSS. 67 | 4. Go back to the `romainmazb-tailwindcss-boilerplate` directory and run npm run watch` to run the development server with hot reload. 68 | 5. Since a new blank theme were created, go to the October backend settings and activate your new theme. 69 | 5. The best and my favorite part: ***Have fun with coding!*** 70 | 71 | Be aware of the fact that every time you create a new file, it can't be detected by the devServer, you need to reload `npm run watch` command. 72 | 73 | Roadmap 74 | ========== 75 | * [x] Cleanup and split files to be more maintainable 76 | * [x] Add rules to PurgeCSS to handle Froala Editor content 77 | * [ ] Waiting for suggestions -> *In progress...* 78 | -------------------------------------------------------------------------------- /blank-src/pages/home.htm: -------------------------------------------------------------------------------- 1 | title = "Demonstration" 2 | url = "/" 3 | layout = "default" 4 | == 5 |
6 |

TailwindCSS Boilerplate Theme

7 |

This is not a theme, it's much more!

8 | 9 |

TailwindCSS Boilerplate theme is not a theme, it's a boilerplate to 10 | create some awesome themes with all the developer's tools includes: TailwindCSS, Webpack, BrowserSync already 11 | configured to 12 | build with the OctoberCMS's directory structure, PostCSS with some the majors plugins, PurgeCSS, and all this 13 | managed with NPM.

14 | 15 |

Have fun!

16 | 17 |

TailwindCSS/Webpack/PostCSS ready

18 |

TailwindCSS, Webpack and PostCSS is already installed and pre-configured to work together. Each 19 | configuration file is pre-built but customizable.

20 |

This boilerplate comes with webpack and fully customised webpack.config.js file for OctoberCMS to manage all your assets: css, 22 | javascript, images, fonts and also all your template files: Webpack will walk through 23 | all you directory and subdirectory present in your theme folder to compile the .htm, .html and .txt 24 | files to catch all the assets dependencies you may have added in them!

25 |

PostCSS is the preprocessor of this boilerplate with the most used plugins. Feel free to add the plugins 26 | you want into the postcss.config.js

27 | 28 |

PurgeCSS & Minification

29 |

To ensure the optimization of your final theme, all unused CSS will be removed with PurgeCSS, and 30 | all the JS and CSS files will be minified

31 | 32 |

Auto-injection of CSS/JS

33 |

All the files presents in the layouts directory will receive the 35 | CSS/JS due to the Webpack auto-injection and a special rule on this directory.

36 | 37 |

Auto-clean of previous build

38 |

This boilerplate uses clean-webpack-plugin to ensure 39 | you don't have any useless files in your themes directory. Your files is cleaned on every build webpack makes. 40 |

41 | 42 |

How to use

43 |

.env file needed

44 |

First of all: if it's not already the case, be sure to run php 45 | artisan october:env. This toolkit uses APP_URL inside of 46 | it to serve local server with BrowserSync and 47 | to correctly sets the paths of the assets. Be sure that it's correctly defined.

48 | 49 |

NPM

50 |

Again, this theme is not a theme, it's a toolkit, based on NPM. To use it, be sure to have node and npm installed on 52 | your machine.

53 |

Then, follow this quick steps:

54 |
    55 |
  1. After installation of this toolkit, rename the folder to what you want your theme's name to be.
  2. 56 |
  3. Modify the theme.yaml from sourcecode or OctoberCMS's administration wit the theme's name, description, 57 | author, and so on...
  4. 58 |
  5. Run npm install from the theme directory to install 59 | dependencies.
  6. 60 |
  7. Run npm run watch to run the the development server with hot 61 | reload.
  8. 62 |
  9. Have fun!
  10. 63 |
64 |

Be aware of the fact that every times you create a new file, you need to reload npm run watch.

66 | 67 |

Folder structure, where to put your code.

68 |

Due to the pre-built configuration, you need to ensure all the modifications you make stay in the 69 | src directory. All directories, subdirectories and files will be 70 | cleaned and recreated by webpack on the root of the the theme's root folder. Think of the src directory as your root 72 | directory

73 |

The defaults directories and files structure of this boilerplate are:

74 |
 75 | /
 76 | /assets
 77 |     /images
 78 |         theme-preview.png
 79 | /custom_filter
 80 |     theme-filter-loader.js
 81 | /node_modules/ (after npm install)
 82 | /src/
 83 |     /assets/
 84 |         /css/
 85 |             entry.css (loads TailwindCSS and inserts your custom css at the right place)
 86 |             themes.css (your actual custom css)
 87 |         /fonts/
 88 |         /images/
 89 |             october.png
 90 |         /javascript/
 91 |             app.js (your custom javascript, copied from October's demo theme)
 92 |     /content/
 93 |     /layouts/
 94 |         /default.htm
 95 |     /pages/
 96 |         404.htm
 97 |         error.htm
 98 |         home.htm
 99 |     /partials/
100 |         /site/
101 |             footer.htm
102 |             header.htm
103 |     index.js
104 | /package.json
105 | /postcss.config.js
106 | /README.md
107 | /tailwindcss.config.js
108 | /theme.yaml
109 | /version.yaml
110 | /webpack.config.js
111 |     
112 |

After webpack build, all the files in the src will be parsed and placed on the same structure from 113 | the root folder.

114 |
115 | 116 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------