Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added build steps #153

Merged
merged 1 commit into from
Oct 9, 2023
Merged

Added build steps #153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
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