-
-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
75 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,89 @@ | ||
# GhostKit - Gutenberg blocks for WordPress | ||
<h1 align="center"> | ||
<a href="https://www.ghostkit.io/"> | ||
<img src="https://www.ghostkit.io/wp-content/uploads/2023/11/ghostkit-favicon.svg" height="40" alt="Ghost Kit - Page Builder Blocks"> | ||
</a> | ||
</h1> | ||
|
||
- Site <https://www.ghostkit.io/> | ||
- WordPress Plugin <https://wordpress.org/plugins/ghostkit/> | ||
<p align="center"> | ||
<a href="https://wordpress.org/plugins/ghostkit/"><img alt="WordPress Plugin Version" src="https://img.shields.io/wordpress/plugin/v/ghostkit"></a> | ||
<a href="https://wordpress.org/plugins/ghostkit/"><img alt="WordPress Plugin Rating" src="https://img.shields.io/wordpress/plugin/rating/ghostkit"></a> | ||
<a href="https://wordpress.org/plugins/ghostkit/"><img alt="WordPress Plugin Downloads" src="https://img.shields.io/wordpress/plugin/dt/ghostkit"></a> | ||
<a href="https://github.com/nk-crew/ghostkit/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/nk-crew/ghostkit"></a> | ||
</p> | ||
|
||
<p align="center">Create sophisticated WordPress websites with advanced blocks, motion effects, and powerful extensions.</p> | ||
|
||
<p align="center"> | ||
<a href="https://www.ghostkit.io/">Website</a> <a href="https://www.ghostkit.io/docs/">Documentation</a> <a href="https://wordpress.org/plugins/ghostkit/">WordPress Plugin</a> <a href="https://www.ghostkit.io/pricing/">Pro Version</a> | ||
</p> | ||
|
||
## Overview | ||
|
||
Ghost Kit enhances the WordPress editing experience with a comprehensive collection of blocks and extensions. Key features: | ||
|
||
- 🧱 25+ Advanced Blocks | ||
- ⚡ Motion Effects & Animations | ||
- 🎨 Typography & Color Customization | ||
- 📱 Responsive Design Tools | ||
- 🛠️ Extended Core Blocks | ||
- 📝 Rich Content Formatting | ||
|
||
## Development | ||
|
||
### Requirements | ||
### Prerequisites | ||
|
||
- PHP >= 7.2 | ||
- Node.js >= 18.0 | ||
- Composer >= 2.0 | ||
|
||
### Getting Started | ||
|
||
1. Clone the repository | ||
2. Install dependencies: | ||
```bash | ||
npm install | ||
``` | ||
|
||
### Development Commands | ||
|
||
| Prerequisite | How to check | How to install | | ||
| ------------------------- | ------------- | ----------------------------------------------- | | ||
| PHP >= 5.5.9 | `php -v` | [php.net](https://php.net/manual/en/install.php) | | ||
| Node.js >= 6.x.x | `node -v` | [nodejs.org](https://nodejs.org/) | | ||
| Composer >= 1.0.0 | `composer -V` | [getcomposer.org](https://getcomposer.org) | | ||
```bash | ||
# Start development with file watcher | ||
npm run dev | ||
|
||
### Installation | ||
# Build for development | ||
npm run build | ||
|
||
- Run `npm install` in the command line. Or if you need to update some dependencies, run `npm update` | ||
# Build for production (with zip file) | ||
npm run build:prod | ||
``` | ||
|
||
### Building | ||
### Code Quality | ||
|
||
- `npm run build` to run build | ||
- `npm run dev` to run build and start files watcher | ||
- `npm run production` to run build and prepare zip files for production | ||
```bash | ||
# Linting | ||
npm run lint:php # Check PHP code | ||
npm run lint:js # Check JavaScript code | ||
npm run lint:css # Check CSS code | ||
|
||
### Linting | ||
# Auto-fixing | ||
npm run format:php # Fix PHP code | ||
npm run format:js # Fix JavaScript code | ||
npm run format:css # Fix CSS code | ||
``` | ||
|
||
We use `pre-commit` and `pre-push` hooks for Git to lint sources with `phpcs`, `eslint` and `stylelint` tasks. | ||
### Testing | ||
|
||
NPM commands to work with linting: | ||
1. [Install Docker](https://www.docker.com/) on your machine | ||
2. Start the server: | ||
```bash | ||
npm run env:start | ||
``` | ||
3. Run tests: | ||
```bash | ||
npm run test:e2e # End-to-end tests | ||
npm run test:unit # Unit tests | ||
``` | ||
|
||
- `npm run php-lint` to show `phpcs` errors | ||
- `npm run php-lint-fix` to automatically fix some of the `phpcs` errors | ||
- `npm run js-lint` to show `eslint` errors | ||
- `npm run js-lint-fix` to automatically fix some of the `eslint` errors | ||
- `npm run css-lint` to show `stylelint` errors | ||
- `npm run css-lint-fix` to automatically fix some of the `stylelint` errors | ||
## License | ||
|
||
All linters compatible with the modern IDE and code editors. | ||
This project is licensed under the GPL-2.0-or-later License - see the [LICENSE](LICENSE.txt) file for details. |