Skip to content

Commit fb5b733

Browse files
committed
update readme
1 parent 019adfa commit fb5b733

File tree

2 files changed

+14
-10
lines changed

2 files changed

+14
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# JB Design System Monorepo Project
22

3-
design-system for jb-web-components and corresponding react components
3+
design-system base on web-component technology.
44

55
## architecture
66

7-
micro-front-end with storybook test bed
8-
this project is in the middle of transform between nodejs and deno and gets a little complicated to run
7+
jb design system is not a all in one package. each of our package has their own repo and their own package name and will be installed separately by user.
8+
to see all of our package list please see [JB Design System Package List](https://javadbat.github.io/design-system/?path=/docs/general-package-list--docs).
9+
10+
this repo is just a monorepo to manage, test & build packages and does not contain any package or common code.
911

1012
## Demo
1113

1214
[Storybook Demo](https://javadbat.github.io/design-system/?path=/docs/getting-started-introduction--docs) see all samples and documentation of design system.
1315
[CodeSandBox Demo](https://codesandbox.io/p/sandbox/jb-design-system-3f63dj) React base environment for playing with code and see the real project implementation of the components.
1416

15-
## usage
17+
## Contribution
18+
19+
>this project is in the middle of transform between nodejs and deno and gets a little complicated to run for the first time.
1620
1721
clone the project with submodules (all components are put in project with submodules)
1822

@@ -36,19 +40,17 @@ npm i
3640
# build all modules in deno:
3741

3842
```bash
43+
# necessary for the first time. this will build all packages
3944
deno task build
45+
# build single package
4046
deno task build --name=jb-input
41-
# we dint build cjs or UMD in watch mode for more speed so pleas build your package without watch mode at least 1 time before publish
47+
# build and watch single package. (just for development. please build package without watch before publishing it)
4248
deno task build --name=jb-input --watch
4349
```
4450

45-
### serve testbeds
51+
### start storybook test environment
4652

4753
```bash
48-
npm run serve
49-
50-
# or
51-
5254
npm start
5355
```
5456
## add a new submodule

docs/getting-started/introduction.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@ import {Meta} from '@storybook/blocks';
77

88
Collection of necessary components to build a web Application with web-components & react components.
99

10+
- works on every Js framework and library like React, Vue, Angular, Svelte, etc.
11+
- dependency free, no need to install any other library or framework.
1012
- mostly focus on form elements and complicated elements with high user interactivity.
1113
- all components are written in web-component with additional React component wrapper around them(access them with "component-name/react").
1214
- first class support for RTL and persian i18n utilities.

0 commit comments

Comments
 (0)