evophp 1.0.19 → 1.0.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +134 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# EvoPHP
|
|
2
|
+
|
|
3
|
+
EvoPHP is a command-line tool designed to simplify the creation, installation, and management of plugins, themes, and projects using Evolution by Kins Okafor. Whether you are starting a new project or extending functionality with plugins and themes, EvoPHP provides the tools you need to get up and running quickly.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Table of Contents
|
|
8
|
+
1. [Installation](#installation)
|
|
9
|
+
2. [Getting Started](#getting-started)
|
|
10
|
+
- [Initialize a New Project](#initialize-a-new-project)
|
|
11
|
+
- [Install a Plugin or Theme](#install-a-plugin-or-theme)
|
|
12
|
+
- [Create a New Plugin or Theme](#create-a-new-plugin-or-theme)
|
|
13
|
+
3. [Plugin Development](#plugin-development)
|
|
14
|
+
4. [Troubleshooting](#troubleshooting)
|
|
15
|
+
5. [License](#license)
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Installation
|
|
20
|
+
|
|
21
|
+
### Prerequisites
|
|
22
|
+
Ensure the following are installed on your system:
|
|
23
|
+
- **Node.js**: Verify by running `node -v` and `npm -v`.
|
|
24
|
+
- **Composer** (optional): For managing PHP dependencies.
|
|
25
|
+
|
|
26
|
+
### Install EvoPHP
|
|
27
|
+
To install EvoPHP globally, run:
|
|
28
|
+
```bash
|
|
29
|
+
npm install -g evophp
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
This command makes the `evophp` CLI available system-wide.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## Getting Started
|
|
37
|
+
|
|
38
|
+
### Initialize a New Project
|
|
39
|
+
To create and set up a new project, run:
|
|
40
|
+
```bash
|
|
41
|
+
evophp init <project-name>
|
|
42
|
+
```
|
|
43
|
+
Example:
|
|
44
|
+
```bash
|
|
45
|
+
evophp init my-project
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
This will:
|
|
49
|
+
1. Clone the EvoPHP repository into a folder named `<project-name>`.
|
|
50
|
+
2. Run `node evolution` with the project name as an argument.
|
|
51
|
+
3. Install Composer dependencies (if a `composer.json` file exists).
|
|
52
|
+
4. Install Node.js dependencies using `npm install`.
|
|
53
|
+
|
|
54
|
+
After setup, navigate to your project folder:
|
|
55
|
+
```bash
|
|
56
|
+
cd my-project
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
To start your project:
|
|
60
|
+
```bash
|
|
61
|
+
npm run start
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
### Install a Plugin or Theme
|
|
67
|
+
To install a plugin or theme, use the following command:
|
|
68
|
+
```bash
|
|
69
|
+
evophp install <plugin|theme> <author/repository-name>
|
|
70
|
+
```
|
|
71
|
+
Example:
|
|
72
|
+
```bash
|
|
73
|
+
evophp install plugin kinsokafor/eEdu
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
The command will fetch the specified plugin or theme and set it up for use.
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
### Create a New Plugin or Theme
|
|
81
|
+
To create a new plugin or theme, use:
|
|
82
|
+
```bash
|
|
83
|
+
evophp new <plugin|theme> <author/repository-name>
|
|
84
|
+
```
|
|
85
|
+
Example:
|
|
86
|
+
```bash
|
|
87
|
+
evophp new plugin kinsokafor/MyAwesomePlugin
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
You will be prompted to provide additional details like:
|
|
91
|
+
- The entry URI.
|
|
92
|
+
- A unique 3-character plugin prefix.
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Plugin Development
|
|
97
|
+
|
|
98
|
+
### Creating a Plugin
|
|
99
|
+
To create your own plugin:
|
|
100
|
+
1. Use the [EvoPlugin GitHub template](https://github.com/kinsokafor/EvoPlugin) and click "Use this template."
|
|
101
|
+
2. Name your repository (e.g., `ExamplePlugin`).
|
|
102
|
+
3. Use the [EvoPlugin.js GitHub template](https://github.com/kinsokafor/EvoPlugin.js) for the JavaScript counterpart. Name it similarly, adding `.js` to the end (e.g., `ExamplePlugin.js`).
|
|
103
|
+
|
|
104
|
+
### Installing Your Plugin
|
|
105
|
+
To install your new plugin:
|
|
106
|
+
```bash
|
|
107
|
+
npm run --i plugin
|
|
108
|
+
```
|
|
109
|
+
You will be prompted for:
|
|
110
|
+
- Plugin name (e.g., `kinsokafor/ExamplePlugin`).
|
|
111
|
+
- Entry URI (e.g., `example-plugin`).
|
|
112
|
+
- Unique 3-character plugin prefix (e.g., `ex1`).
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## Troubleshooting
|
|
117
|
+
|
|
118
|
+
- **Permission Issues**: On Linux/macOS, use `sudo` for commands requiring elevated permissions.
|
|
119
|
+
- **Node.js Installation**: Verify installation using `node -v` and `npm -v`.
|
|
120
|
+
- **Versioning Conflicts**: If updating, increment the version in `package.json`.
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## License
|
|
125
|
+
|
|
126
|
+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
### Key Features of This Version:
|
|
131
|
+
1. **Clear Commands**: All commands are listed with syntax, examples, and expected results.
|
|
132
|
+
2. **Plugin Development**: Detailed instructions for creating and managing plugins.
|
|
133
|
+
3. **Troubleshooting Section**: Practical solutions to common issues.
|
|
134
|
+
4. **User-Friendly Layout**: A clean structure with headings and examples for easy navigation.
|