Development
Development
Create Plugin
With erxes, you can create your own plugins or extend the existing ones, which would help you to enhance your experience...
Create General Plugin
With erxes, you can create your own plugins or extend the existing ones, which would help you to enhance your experience and increase your revenue by adding the value on your products/services or selling it on our our marketplace. This guideline will help you to develop your own plugins.
✋ Caution
- Before you start developing your own plugins, ensure there is no plugins with the same name or similar name in our marketplace that would bring any confusion as the name would be used many places starting from your
API,GraphQL,query,mutation, etc. - Name must be in small letters with no symbols and space in between.
- Name of All your
GraphQLtype,query,mutationmust start with your plugin name. - Names of your database collection also must start with your plugin name.
- Name of your UIroutes or
url-s also must be start with you pluging name.
Installing erxes
Please go to the installation guideline to install erxes XOS, but no need to run the erxes with the same direction.
❌ Danger
We assume you've already installed erxes XOS on your device. Otherwise the guideline below would not work out properly. Please make sure you should be back after you install erxes XOS using the installation guideline.
Plugin API
Plugin development in API part requires the following software prerequisites to be already installed on your computer.
Typescript
TypeScript is a popular choice for programmers accustomed to other languages with static typing, such as C# and Java.
Graphql
GraphQL is a query language for your API, and a server-side runtime for executing queries using a type system you define for your data.
Express.js
Express is a minimal and flexible Node.js web application framework that provides a robust set of features for web and mobile applications.
Mongodb
MongoDB empowers innovators to create, transform, and disrupt industries by unleashing the power of software and data.
Redis
Redis is an open source (BSD licensed), in-memory data structure store used as a database, cache, message broker, and streaming engine.
Plugin UI
Plugin development in UI part requires the following software prerequisites to be already installed on your computer.
Typescript
TypeScript is a popular choice for programmers accustomed to other languages with static typing, such as C# and Java.
Webpack
Webpack is a module bundler. Webpack can take care of bundling alongside a separate task runner.
Creating New Plugin
Each plugin is composed of two parts, API and UI
- Create new folders for both using the following command.
cd erxes-next
pnpm create-plugin