-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
69 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
# WOW Design System | ||
|
||
![image](https://github.com/user-attachments/assets/2a43de37-0e69-4b61-a8eb-4fb3e9ec167e) | ||
와우 디자인 시스템은 디자인에 대한 고민을 줄이고 개발에만 집중할 수 있도록 제작된 GDSC Hongik의 디자인 시스템 입니다. | ||
|
||
![npm](https://img.shields.io/npm/v/wowds-ui) ![license](https://img.shields.io/npm/l/wowds-ui) | ||
|
||
--- | ||
|
||
## 📦 Installation | ||
|
||
```bash | ||
npm install wowds-ui | ||
|
||
pnpm add wowds-ui | ||
|
||
yarn add wowds-ui | ||
``` | ||
|
||
## 🛠️ Usage | ||
|
||
|
||
```ts | ||
import Button from "wowds-ui/Button"; | ||
|
||
function App() { | ||
return <Button variant="primary">Click Me!</Button>; | ||
} | ||
|
||
export default App; | ||
``` | ||
|
||
## 🤝 Contributing | ||
|
||
``` | ||
1. 레포 클론 | ||
git clone https://github.com/GDSC-Hongik/wow-design-system.git | ||
2. 디렉토리 이동 | ||
cd packages/wow-ui | ||
3. 의존성 설치 | ||
pnpm install | ||
``` | ||
|
||
## 🌐 Links | ||
- [npm](https://www.npmjs.com/package/wowds-ui) | ||
- [storybook](https://wow-design-system-wow-ui.vercel.app/?path=/docs/ui-avatar--docs) | ||
- [wow-docs](https://wow-design-system-wow-docs.vercel.app/overview) | ||
|
||
## 🚀 Tech Stack | ||
<div align="left"> | ||
<div> | ||
<img src="https://img.shields.io/badge/TypeScript-3178C6?style=flat-square&logo=typescript&logoColor=white"> | ||
<img src="https://img.shields.io/badge/React-61DAFB?style=flat-square&logo=react&logoColor=black"> | ||
<img src="https://img.shields.io/badge/Storybook-FF4785?style=flat-square&logo=storybook&logoColor=white"> | ||
</div> | ||
<div> | ||
<img src="https://img.shields.io/badge/Turbo-333333?style=flat-square&logo=turbo&logoColor=white"/> | ||
<img src="https://img.shields.io/badge/Panda CSS-EF7C8E?style=flat-square&logo=pandacss&logoColor=white"/> | ||
<img src="https://img.shields.io/badge/Rollup-EC4A3F?style=flat-square&logo=rollup.js&logoColor=white"/> | ||
<img src="https://img.shields.io/badge/Playwright-2EAD33?style=flat-square&logo=microsoftedge&logoColor=white"/> | ||
<img src="https://img.shields.io/badge/Jest-C21325?style=flat-square&logo=jest&logoColor=white"/> | ||
</div> | ||
<div> | ||
<img src="https://img.shields.io/badge/ESlint-4B32C3?style=flat-square&logo=eslint&logoColor=white"> | ||
<img src="https://img.shields.io/badge/Prettier-F7B93E?style=flat-square&logo=prettier&logoColor=white"> | ||
</div> | ||
</div> |