https://github.com/scify/eqafit-wordpress-theme
The WordPress theme of the EQAFIT website
https://github.com/scify/eqafit-wordpress-theme
Last synced: 2 months ago
JSON representation
The WordPress theme of the EQAFIT website
- Host: GitHub
- URL: https://github.com/scify/eqafit-wordpress-theme
- Owner: scify
- License: gpl-2.0
- Created: 2022-09-06T08:00:04.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-24T12:58:17.000Z (about 2 years ago)
- Last Synced: 2024-12-27T23:44:06.335Z (4 months ago)
- Language: CSS
- Size: 594 KB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/Automattic/_s)
# EQAFIT WordPress Theme
## About
This WordPress theme is based on the popular `_s` theme template.
===
* A modern workflow with a pre-made command-line interface to turn your project into a more pleasant experience.
* A just right amount of lean, well-commented, modern, HTML5 templates.
* A custom header implementation in `inc/custom-header.php`. Just add the code snippet found in the comments of `inc/custom-header.php` to your `header.php` template.
* Custom template tags in `inc/template-tags.php` that keep your templates clean and neat and prevent code duplication.
* Some small tweaks in `inc/template-functions.php` that can improve your theming experience.
* A script at `js/navigation.js` that makes your menu a toggled dropdown on small screens (like your phone), ready for CSS artistry. It's enqueued in `functions.php`.
* 2 sample layouts in `sass/layouts/` made using CSS Grid for a sidebar on either side of your content. Just uncomment the layout of your choice in `sass/style.scss`.
Note: `.no-sidebar` styles are automatically loaded.
* Smartly organized starter CSS in `style.css` that will help you to quickly get your design off the ground.
* Full support for `WooCommerce plugin` integration with hooks in `inc/woocommerce.php`, styling override woocommerce.css with product gallery features (zoom, swipe, lightbox) enabled.
* Licensed under GPLv2 or later. :) Use it to make something cool.
Installation
---------------
### Requirements
`_s` requires the following dependencies:
- [Node.js](https://nodejs.org/)
- [Composer](https://getcomposer.org/)
### Quick Start
Clone or download this repository, change its name to something else (like, say, `megatherium-is-awesome`), and then you'll need to do a six-step find and replace on the name in all the templates.
1. Search for `'_s'` (inside single quotations) to capture the text domain and replace with: `'megatherium-is-awesome'`.
2. Search for `_s_` to capture all the functions names and replace with: `megatherium_is_awesome_`.
3. Search for `Text Domain: _s` in `style.css` and replace with: `Text Domain: megatherium-is-awesome`.
4. Search for _s (with a space before it) to capture DocBlocks and replace with: Megatherium_is_Awesome.
5. Search for `_s-` to capture prefixed handles and replace with: `megatherium-is-awesome-`.
6. Search for `_S_` (in uppercase) to capture constants and replace with: `MEGATHERIUM_IS_AWESOME_`.
Then, update the stylesheet header in `style.css`, the links in `footer.php` with your own information and rename `_s.pot` from `languages` folder to use the theme's slug. Next, update or delete this readme.
### Setup
To start using all the tools that come with `_s` you need to install the necessary Node.js and Composer dependencies :
```sh
$ composer install
$ npm install
```
### Available CLI commands
`_s` comes packed with CLI commands tailored for WordPress theme development :
- `composer lint:wpcs` : checks all PHP files against [PHP Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/).
- `composer lint:php` : checks all PHP files for syntax errors.
- `composer make-pot` : generates a .pot file in the `languages/` directory.
- `npm run compile:css` : compiles SASS files to css.
- `npm run compile:rtl` : generates an RTL stylesheet.
- `npm run watch` : watches all SASS files and recompiles them to css when they change.
- `npm run lint:scss` : checks all SASS files against [CSS Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/css/).
- `npm run lint:js` : checks all JavaScript files against [JavaScript Coding Standards](https://developer.wordpress.org/coding-standards/wordpress-coding-standards/javascript/).
- `npm run bundle` : generates a .zip archive for distribution, excluding development and system files.
Now you're ready to go! The next step is easy to say, but harder to do: make an awesome WordPress theme. :)
## Self-assessment tool
This theme uses the self-assessment tool as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
So, in order to pull the changes in the submodule, run:
```bash
git pull
git submodule update --recursive --remote --merge
cd eqafit-quiz-tool/
npm install
npm run build
```
These commands will pull and merge the changes, install any dependencies, build the submodule project, and prepare the `.js` and `.css` files.
#### Setting the env variables for the self-assessment tool submodule
Depending on the WordPress URL and the server configuration, we will need to "tell" to the self-assessment tool submodule where to locate the `data.json` file.
So, we should create a `.env.production.local` file (which is already set not to be tracked by Git), with the following contents:
```bash
#.env.production.local
VITE_REST_API_AUTH_USERNAME=
VITE_REST_API_AUTH_USERPASSWORD=
```
(**Note** to set the variable appropriately, this was just an example!)
Once you add the new `.env.*` file, you must run `npm run build` or `npm run serve` again.