README.en.md
[English](./README.en.md)
# AIAO
[](https://circleci.com/gh/aiao-io/aiao/tree/master) [](https://codecov.io/gh/aiao-io/aiao) [](https://crowdin.com/project/aiao-io) [](https://opensource.org/licenses/MIT) [](https://app.fossa.io/projects/git%2Bgithub.com%2Faiao-io%2Faiao?ref=badge_shield) [](https://www.codefactor.io/repository/github/aiao-io/aiao) [](https://codeclimate.com/github/aiao-io/aiao/maintainability) [](https://lgtm.com/projects/g/aiao-io/aiao/context:javascript)
Use `monorepo` style for management some `npm` package。
## Libs
Versions less than ` 1 ` are internal beta versions, please use with caution
### Elements
| Package | Description | Version | Scale | |
| ------------------------ | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| `@aiao/elements` | web component | [](https://www.npmjs.com/@aiao/elements) | [](https://bundlephobia.com/result?p=@aiao/elements) | [Details](./libs/elements) |
| `@aiao/elements-angular` | angular version | [](https://www.npmjs.com/@aiao/elements-angular) | [](https://bundlephobia.com/result?p=@aiao/elements-angular) | [Details](./libs/elements-angular) |
| `@aiao/elements-react` | react version | [](https://www.npmjs.com/@aiao/elements-react) | [](https://bundlephobia.com/result?p=@aiao/elements-react) | [Details](./libs/elements-react) |
| `@aiao/elements-cdk` | component Dev Kit | [](https://www.npmjs.com/@aiao/elements-cdk) | [](https://bundlephobia.com/result?p=@aiao/elements-cdk) | [Detail](./libs/elements-cdk) |
### Angular
| Package | Description | Version | Scale | |
| ----------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
| `@aiao/lazy-module` | lazy load `angular module` | [](https://www.npmjs.com/@aiao/lazy-module) | [](https://bundlephobia.com/result?p=@aiao/lazy-module) | [Details](./libs/lazy-module) |
| `@aiao/lazy-element` | lazy load `angular element` | [](https://www.npmjs.com/@aiao/lazy-element) | [](https://bundlephobia.com/result?p=@aiao/lazy-element) | [Details](./libs/lazy-element) |
| `@aiao/lazy-component` | lazy load any `module`'s `component` | [](https://www.npmjs.com/@aiao/lazy-component) | [](https://bundlephobia.com/result?p=@aiao/lazy-component) | [Details](./libs/lazy-component) |
| `@aiao/stencil-toolkit` | `stencil` toolkit from angular , support `nx` | [](https://www.npmjs.com/@aiao/stencil-toolkit) | [](https://bundlephobia.com/result?p=@aiao/stencil-toolkit) | [Details](./libs/stencil-toolkit) |
### utils
| Package | Description | Version | Scale | |
| --------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| `@aiao/color` | color tool | [](https://www.npmjs.com/@aiao/color) | [](https://bundlephobia.com/result?p=@aiao/color) | [Details](./libs/color) |
| `@aiao/util` | utils | [](https://www.npmjs.com/@aiao/util) | [](https://bundlephobia.com/result?p=@aiao/util) | [Details](./libs/util) |
| `@aiao/image-storage` | online image address generator | [](https://www.npmjs.com/@aiao/image-storage) | [](https://bundlephobia.com/result?p=@aiao/image-storage) | [Details](./libs/image-storage) |
| `@aiao/typeorm-plus` | make typeorm support sequelize queries | [](https://www.npmjs.com/@aiao/typeorm-plus) | [](https://bundlephobia.com/result?p=@aiao/typeorm-plus) | [Details](./libs/typeorm-plus) |
## Project Structure
The structure mostly follows the [ Nx ](https://github.com/nrwl/nx) rule
- `apps` application directory
- `libs` directory of libraries
- `tools` utils
## Install
- ` cypress ` download is slow, please download and configure environment variables manually before installation ` CYPRESS_INSTALL_BINARY = 0 ` skip download, [ more installation methods ](cypress-install-zh-cn)
- Please use ` yarn ` as the default installation method for this project. And force ` registry ` to be configured as the default. If you download too slowly, you can delete the `.yarnrc ` and `.npmrc ` files to speed up the installation.
```console
yarn
```
## Build Project
### Build All Libs
```console
yarn build:libs
```
### Build ` util ` library separately
```console
ng build util
```
## Unit Tests
> Some libraries require database support, please start by yourself
### Test All Libs
```console
yarn test
```
### Test `util` Lib
```console
ng test util
```
## Contribute
Welcome all of you to contribute code, please check the [ Contribution Guide ](CONTRIBUTING.md)
## License MIT
[](https://app.fossa.io/projects/git%2Bgithub.com%2Faiao-io%2Faiao?ref=badge_large)
<!-- npm -->
<!-- npm url -->
<!-- bundlephobia -->
<!-- bundlephobia url -->
<!-- cypress -->