DripTable Development Guide

Before Development

English | 简体中文

Knowledge points that you need to master before developing

What is JSON Schema?

1. JSON Schema is a vocabulary that allows you to annotate and validate JSON documents.
2. JSON Schema official document
3. JSON Schema guide

What is Lerna?

1. Lerna is a tool for managing JavaScript projects with multiple packages.
2. Lerna official document
3. Lerna guide

Environment

• install git, node, yarn. version requirement: node >=13.14.0, yarn >= 1.0.0

• configure NPM source if needed.

  configure NPM source

  npm config set registry https://registry.npmjs.com/

  login

  npm adduser (--registry=https://registry.npmjs.com/)
  • Download codes

Start

1. install dependencies

   lerna bootstrap

2. build independecies

   yarn

   yarn run build

   npm

   npm run build

3. run

   yarn start

visit http://localhost:8000 in browser.

Directory

• update continually

├── docs                           // official website
│ ├── drip-table                   // drip-table sub page
│ │ ├── changelog
│ │ │ └── index.md                 // log markdown
| | ├── functions                  // drip-table functions
| | ├── guide                      // drip-table guide
| | ├── sample                     // drip-table samples
| | ├── faq.md                     // drip-table faq
| | └── index.md                   // drip-table document entry
│ ├── drip-table-generator         // drip-table-generator sub page
│ │ ├── changelog
│ │ │ └── index.md                 // log markdown
| | ├── preview                    // drip-table-generator demos
| | ├── faq.md                     // drip-table-generator faq
| | └── index.md                   // drip-table-generator document entry
│ ├── global-schema.ts             // global schema for demos
│ ├── index.css                    // official website CSS
│ ├── index.md                     // official website markdown
│ ├── index.tsx                    // official website entry
│ └── loading.js                   // official website loading component
└── packages                       // codes menu
  ├── drip-table                   // drip-table codes
  └── drip-table-generator         // drip-table visual tool

Development

1. Fork.
2. Create a new branch that names to express the features simply.
3. Coding.
4. Create a pull request.

• For more details of drip-table, see README;
• For more details of drip-table-generator, see README;

NPM Publish

If you changed drip-table source code，you should update package.json and changelog ， enter the drip-table catalogue and execute npm publish。

If you changed drip-table-generator source code，you should update package.json and changelog ， enter the drip-table-generator catalogue and execute npm publish。

If you don't have permission to publish npm package, go to the [Official Wechat group] (./Contact. md) and contact the group owner to add permission, npm owner add<username><package name>

Release official website

yarn run build:docs