Home

Awesome

<p align="center"> <img src="./images/logo.png" /> </p> <p align="center"> <a href="https://github.com/imcuttle/mometa/actions"><img src="https://img.shields.io/github/workflow/status/imcuttle/mometa/Test/master?style=flat-square" /></a> <a href="https://codecov.io/github/imcuttle/mometa?branch=master"><img src="https://img.shields.io/codecov/c/github/imcuttle/mometa/master.svg?style=flat-square" /></a> <a href="https://prettier.io/"><img src="https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square" /></a> <a href="https://conventionalcommits.org"><img src="https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square" /></a> </p> <p align="center"> The tool for R&D which has low-code meta programming and WYSIWYG editing </p> <p align="center"> English | <a href="README_zh_CN.md">简体中文</a> </p>
<!-- toc --> <!-- tocstop -->

Why use it?

mometa is not similar to the traditional lowcode project which is schema based. mometa is code based, It's WYSIWYG editing following code ast.

Which problems mometa can resolved:

The positioning of mometa is more based on the local development model of programmers, adding the ability of visual coding (the local code file itself is also modified);
It is not recommended to set up a local development environment for remote services, so there is no online deployment.
The current implementation relies on the webpack dev development mode, and compatibility with vite will be considered in the future.

<p align="center"> <img src="./images/snapshot.png" /> </p>

Features

scenes to be used

Develop a new page

  1. Use team development instructions to add an empty placeholder route & page
  2. Enter mometa, view local materials and remote material markets, select the materials you need, drag and drop directly, and the basic page layout is completed.
  3. Enter the IDE, complete data joint debugging, data transfer, etc., and source code development

There are existing historical projects and the iteration function is needed, only in a small ui module.

  1. Enter mometa and insert material operation
  2. Reverse positioning to directly enter IDE source code development

Operation demonstration

edit

Reverse positioning

Support positioning code location from view

Insert material

Visually insert materials

Delete view

Mobile view

Edit code

Preview

Material Preview

Responsive layout

Route simulation

How to implement

See mometa implementation principle

Quick start

Since mometa relies on the local development environment and is only used in the local development environment, there is no online demo built; it can be used during local development.

git clone https://github.com/imcuttle/mometa.git
cd mometa
pnpm install
pnpm run start:app:cr # 开启本地开发预览模式

how to use

Install dependencies

npm i @mometa/editor -D

Use antd material

  1. Install antd materials
npm i @mometa-mat/antd -D
  1. Create mometa-material.config.js in the project root directory
module.exports = [require('@mometa-mat/antd').default]

You can also create your own material library. For data structure rules, see Material definition

Access editor

webpack.config.js is modified as follows:

const MometaEditorPlugin = require('@mometa/editor/webpack')

module.exports = {
  module: {
    rules: [
      {
        test: /\.(js|mjs|jsx|ts|tsx)$/,
        // Note that only the file directory you need to edit needs to be processed
        include: paths.appSrc,
        loader: require.resolve('babel-loader'),
        options: {
          plugins: [isEnvDevelopment && require.resolve('@mometa/editor/babel/plugin-react')]
        }
      }
    ]
  },
  plugins: [
    isEnvDevelopment &&
      new MometaEditorPlugin({
        react: true,
        //Open material preview
        experimentalMaterialsClientRender: true
      })
  ]
}

Note: You do not need to enable the official default react-refresh when using it. Mometa will enable the react-refresh capability by default

Start webpack dev server and open http://localhost:${port}/mometa/

The provided example can be found at @mometa/app

NPM Packages

Author

This library is written and maintained by imcuttle, <a href="mailto:imcuttle@163.com">imcuttle@163.com</a>.