Skip to content

Commit

Permalink
docs: move file and join documentation (#142)
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastiandotdev authored Apr 16, 2024
1 parent cb6b231 commit b97fff6
Show file tree
Hide file tree
Showing 6 changed files with 29 additions and 33 deletions.
File renamed without changes
File renamed without changes
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Open UI

<img src="./assets/OpenLand.jpeg" alt="Open Land logo" align="right" width="100">
<img src="./.github/OpenLand.jpeg" alt="Open Land logo" align="right" width="100">

This is the source code for [openui](https://openui.up.railway.app/) by Open Land

Expand All @@ -15,13 +15,36 @@ This is the source code for [openui](https://openui.up.railway.app/) by Open Lan

## Getting Started

<img src="./assets/preview.png" alt="Open Land logo" align="right" width="300">
<img src="./.github/preview.png" alt="Open Land logo" align="right" width="300">
This design system is totally easy to use with the aim of facilitating upcoming new projects. The design system is a challenge for our team. You can gladly contribute and guide us with ideas to improve... We would be keen to hear any feedback on this project.

<br>
<br>
<br>
<br>
## Configure workspaces

### Install turbo

Install turbo globally.

```shell
pnpm install turbo --global
```

For more details about installation, see Installing Turborepo

### Scripts

1. Run mode dev.

```shell
turbo dev
```

2. Run build packages

```shell
turbo build
```

Your ready for worker and add components.

## Components

Expand Down
Binary file removed assets/no-profile.jpeg
Binary file not shown.
Binary file removed assets/preview-prod.png
Binary file not shown.
27 changes: 0 additions & 27 deletions assets/workspace.md

This file was deleted.

0 comments on commit b97fff6

Please sign in to comment.