Skip to content

aialvi/GourmetDine-FSE-Theme

Repository files navigation

=== GourmetDine ===
Contributors: Aminul Islam Alvi
Tested up to: 6.4
Requires at least: 6.3
Requires PHP: 7.4
Version: 1.0.0
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
Copyright: Aminul Islam Alvi

A full site editing theme for restaurants, cafes, and food bloggers.

== Guide ==

=== Folder structure ===

- Assets. Images, JavaScript, and CSS files.
- Inc. Filters, fonts, block variations, registered block styles.
- Parts. HTML template parts.
- Patterns. Block pattern examples.
- Styles. Global style variations.
- Templates. HTML block templates.

functions.php -Used to enqueue styles and add theme support.
index.php     -"Silence is golden"
style.css     -Required to activate the theme.
theme.json    -Settings and default styles.
license.txt   -GPL v2
readme.txt    -Information about the theme.
screenshot.png

=== Tooling ===

Note, the tools are optional and requires:
node minimum version 14.15.0
npm from 6.14.8 up to 7. It will not work with higher versions.

You can install the tools by opening your terminal in the themes root folder
and entering the following commands:
npm install
composer install

==== CSS ====

This theme includes both human-readable and minified CSS inside the assets/css folder.
For improved performance, the theme loads the minified CSS on the front and in the editor.

To make changes to the CSS:
1) Edit the human readable CSS file (the .css file that does not end with .min.css)
2) Minify the CSS by running the command: gulp

To add additional block styles:
1) Create a new CSS file inside the assets/css/blocks folder.
Use the slug of the block as the file name: latest-comments.css
2) Next, open functions.php and add the slug to the $styled_blocks array inside the setup function.
3) Minify the CSS with the command: gulp

To watch for changes, use the command: gulp watch

To compare your code against the CSS coding standards, use the command: npm run lint:css

==== PHP ====

To compare your code against the PHP coding standards,
use the command: composer standards:check

For PHPStan analysis, use the command: composer analyze

==== JavaScript ====

To compare your code against the JavasCript coding standards,
use the command: npm run lint:js

== Changelog ==
1.0.0 Initial release

== Licence ==
GourmetDine is distributed under the terms of the GNU GPL.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.