Skip to content

Commit

Permalink
feat(root): updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Carlos Leandro Cruz Ferrer committed Aug 30, 2022
1 parent 310de98 commit 353efe5
Showing 1 changed file with 68 additions and 11 deletions.
79 changes: 68 additions & 11 deletions README.md
Expand Up @@ -2,38 +2,95 @@

> Siemens iX monorepo
![Prerequisite](https://img.shields.io/badge/npm-%3E%3D8.x.x-blue.svg)
![Prerequisite](https://img.shields.io/badge/node-%3E%3D16.16.x-blue.svg)
![version](https://img.shields.io/badge/version-0.0.0-green.svg)
![npm](https://img.shields.io/badge/npm-%3E%3D8.x.x-blue.svg)
![node](https://img.shields.io/badge/node-%3E%3D16.16.x-blue.svg)
![yarn](https://img.shields.io/badge/yarn->=1.x.x-blue.svg)
[![License: SEE LICENSE IN <LICENSE.md>](https://img.shields.io/badge/License-SEE%20LICENSE%20IN%20LICENSE.md-yellow.svg)](https://***REMOVED***/siemens-ix/siemens-ix/-/blob/main/LICENSE.md)


## Prerequisites
## Usage

- npm >=8.x.x
- node >=16.16.x

## Installation & Usage
### Installation

```sh
yarn install
```

### Build
```sh
yarn build
yarn build || yarn build --filter=<workspace-name>
```

### Development
```sh
yarn start
yarn start || yarn start --filter=<workspace-name>
```

### Test

- Unit TBD

- E2E TBD

### Visual regression testing

**_Docker cli must be installed on your system_**

```sh
yarn build --filter=<workspace-name>
yarn visual-regression
```

### Documentation

Serve documentation [locally](http://localhost:3000/siemens-ix/)

```sh
yarn start --filter=<workspace-name>
yarn start --filter=documentation
```

### Release

```sh
yarn release
```

## Project structure

### Package `core`

Contains all styles and the webcomponents.

**_published as `@siemens/ix`_**

### Package `react`

Contains the wrapper components for react.

**_published as `@siemens/ix-react`_**

### Package `angular`

Contains the wrapper components for angular.

**_published as `@siemens/ix-angular`_**

### Package `react-test-app` and `angular-test-app`

Contains a playground application to explore and test `ix` components.
Inside the `x-test-app`'s are also the preview source code for the documentation. (`src/preview-examples`)

**_Not published_**

### Package `documentation`

Contains the documentation.

### Package `aggrid`

Contains the brand and classic theme for the aggrid library

**_published as `@siemens/ix-aggrid`_**

## 🤝 Contributing

Expand Down

0 comments on commit 353efe5

Please sign in to comment.