kowebtech/evolution

PHP/Vue development framework

dev-main 2024-04-24 13:57 UTC

This package is auto-updated.

Last update: 2024-04-24 13:59:51 UTC


README

Requirements

  • Node js installed
  • npm installed
  • PHP installed
  • MySQL installed
  • Composer installed

Installation

Run git clone https://github.com/kinsokafor/evolution.git your-project-name in your desired project location

Run cd your-project-name

Run node evolution

Run composer install

Run npm install

Set up

Run npm run start or npm start

  • Get your database credentials handy (host name, user name, password, and database name)

Install Plugin

Plugin installation can be done by simply running npm run plugin. You will be prompted to provide the name of the plugin which should be a full github name of the plugin including the author name without "https://github.com/" example "kinsokafor/eEdu" then press enter.

Create New Plugin

Go to https://github.com/kinsokafor/EvoPlugin and click on "use this template" then "create new repository". Name your repository (The name of your plugin) for example "ExamplePlugin". You must be consistent with naming your plugin because you will use exactly the same name and it's exact casing for creating the javaScript counterpart. Allow it for some time to clone and create your plugin files.

Also go to https://github.com/kinsokafor/EvoPlugin.js and repeat the same process. This time the name of your repository must be the same as the name of the plugin which you used to create the first repository then followed by .js for example "ExamplePlugin.js"

Then just like plugin installation, run npm run --i plugin provide the name of the plugin that your earlier used to create your repository. remember to format it properly including the author name for example "kinsokafor/ExamplePlugin".

You will be required to provide the entryURI of your plugin which will be the index of your new plugin. Get a unique name such as "example-plugin".

You will also be required to provide the plugin prefix. The plugin prefix is just 3 alphanumeric characters that are unique to the naming of your plugin so that it won't collide with anyother plugin used in your project. Make it as unique as possible

Click Enter.