Skip to content

Commit

Permalink
[docs] Added build steps (#153)
Browse files Browse the repository at this point in the history
Signed-off-by: Debaditya Som <[email protected]>
  • Loading branch information
Debaditya-Som authored Oct 9, 2023
1 parent 498fb71 commit 20d2faf
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

The Sistent Design System from Layer5 provides the open source building blocks to design and implement consistent, accessible, and delightful product experiences.


### Packages

Design System components in React, usually built with Vite.
Expand All @@ -20,6 +21,13 @@ List of npm packages:

- Design System components in React.js

### Prerequisites

Before you begin, ensure you have the following installed on your system:

- Node.js
- Yarn

### How to get started

Use `corepack enable` to go ahead and install yarn.
Expand All @@ -29,6 +37,34 @@ Use `corepack enable` to go ahead and install yarn.

<div>&nbsp;</div>


### Installation

To set up the project, run the following command to install dependencies:

```
setup:
yarn install
```
To build the project, you can use the following command:
```
build: install
yarn run build-all
```

To check if your code meets the formatting standards, you can run:
```
format-check:
yarn run format:check
```

To automatically fix formatting issues, you can run
```
format-fix:
yarn run format:write
```


## Join the Layer5 community!

<a name="contributing"></a><a name="community"></a>
Expand Down

0 comments on commit 20d2faf

Please sign in to comment.