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.

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

feat(design-systems-for-developers): 디자인 시스템 구축하기 #7

Merged
merged 21 commits into from
Nov 15, 2022
Merged
Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
3669179
feat(design-systems-for-developers): 개발자를 위한 디자인 시스템 패키지 생성
minzzang144 Nov 7, 2022
4a7ea8c
feat(design-systems-for-developers): 빌드
minzzang144 Nov 7, 2022
87b733d
feat(design-systems-for-developers): 리뷰 - chromatic
minzzang144 Nov 7, 2022
523b500
feat(design-systems-for-developers): 리뷰 - CI
minzzang144 Nov 7, 2022
530e29d
feat(design-systems-for-developers): 리뷰 - CI-2
minzzang144 Nov 7, 2022
d53829d
feat(design-systems-for-developers): 비주얼 리뷰 요청하기
minzzang144 Nov 7, 2022
c11d9ef
"revert(design-systems-for-developers): 비주얼 리뷰 요청하기"
minzzang144 Nov 10, 2022
5309c40
feat(design-systems-for-developers): href에 대한 단위 테스트
minzzang144 Nov 10, 2022
063bcd9
feat(design-systems-for-developers): 테스트 - CI
minzzang144 Nov 10, 2022
c3c2a00
feat(design-systems-for-developers): 테스트 - CI-2
minzzang144 Nov 10, 2022
135a5a1
feat(design-systems-for-developers): 테스트 - CI-3
minzzang144 Nov 10, 2022
b4853f8
feat(design-systems-for-developers): 테스트 - CI-4
minzzang144 Nov 10, 2022
60a3b5b
feat(design-systems-for-developers): 테스트 - CI-5
minzzang144 Nov 10, 2022
a19e417
feat(design-systems-for-developers): 접근성 테스트
minzzang144 Nov 10, 2022
57e671d
feat(design-systems-for-developers): 문서화
minzzang144 Nov 11, 2022
c8afbc3
feat(design-systems-for-developers): Markdown/MDX를 사용한 Supercharge 문서화
minzzang144 Nov 11, 2022
cb16bfa
feat(design-systems-for-developers): Markdown/MDX를 사용한 Supercharge 문서화-2
minzzang144 Nov 11, 2022
134dfa5
feat(design-systems-for-developers): 디자인 시스템 배포 준비
minzzang144 Nov 15, 2022
c552f8d
feat(design-systems-for-developers): 매뉴얼적으로 Auto를 이용해 처음으로 배포 for v0.…
minzzang144 Nov 15, 2022
2fed036
Bump version to: 0.1.0 [skip ci]
minzzang144 Nov 15, 2022
4eb667a
feat(design-systems-for-developers): Github Actions로 릴리즈 자동화
minzzang144 Nov 15, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/workflows/chromatic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Name of our action
name: "Chromatic"
# The event that will trigger the action
on: push

# What the action will do
jobs:
chromatic-deployment:
# Operating System
runs-on: ubuntu-latest
# Job steps
steps:
- uses: actions/checkout@v1
- name: Install dependencies
run: yarn
# 👇 Adds Chromatic as a step in the workflow
- name: Publish Project 1 to Chromatic
uses: chromaui/action@v1
# Chromatic GitHub Action options
with:
# 👇 Chromatic projectToken, refer to the manage page to obtain it.
projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
workingDir: packages/design-systems-for-developers
- run: yarn test
working-directory: packages/design-systems-for-developers
2 changes: 2 additions & 0 deletions packages/design-systems-for-developers/.env
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
SKIP_PREFLIGHT_CHECK=true
CHROMATIC_TOKEN=89975cd00ca7
25 changes: 25 additions & 0 deletions packages/design-systems-for-developers/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# production
/build

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*

.env
15 changes: 15 additions & 0 deletions packages/design-systems-for-developers/.storybook/main.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
module.exports = {
stories: [
"../src/Intro.stories.mdx",
"../src/**/*.stories.mdx",
"../src/**/*.stories.@(js|jsx|ts|tsx)",
],
addons: [
"@storybook/addon-links",
"@storybook/addon-essentials",
"@storybook/addon-interactions",
"@storybook/preset-create-react-app",
"@storybook/addon-a11y",
],
framework: "@storybook/react",
};
32 changes: 32 additions & 0 deletions packages/design-systems-for-developers/.storybook/preview.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import React from "react";

import { GlobalStyle } from "../src/shared/global";

/*
* Global decorator to apply the styles to all stories
* Read more about them at:
* https://storybook.js.org/docs/react/writing-stories/decorators#global-decorators
*/
export const decorators = [
(Story) => (
<>
<GlobalStyle />
<Story />
</>
),
];

/*
* Read more about global parameters at:
* https://storybook.js.org/docs/react/writing-stories/parameters#global-parameters
*/
export const parameters = {
actions: { argTypesRegex: "^on[A-Z].*" },
// Storybook a11y addon configuration
a11y: {
// the target DOM element
element: "#root",
// sets the execution mode for the addon
manual: false,
},
};
21 changes: 21 additions & 0 deletions packages/design-systems-for-developers/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2018 Chroma Software Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
83 changes: 83 additions & 0 deletions packages/design-systems-for-developers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@

<p align="center">
<a href="https://www.chromatic.com/">
<img alt="Chromatic" src="https://avatars2.githubusercontent.com/u/24584319?s=200&v=4" width="60" />
</a>
</p>

<h1 align="center">
Chromatic's Design Systems for Developers tutorial template
</h1>

This template ships with the main React configuration files you'll need to get up and running fast.

## 🚅 Quick start

1. **Create the application.**

Use [degit](https://github.com/Rich-Harris/degit) to get this template.

```shell
# Clone the template
npx degit chromaui/learnstorybook-design-system-template learnstorybook-design-system
```

1. **Install the dependencies.**

Navigate into your new site’s directory and install the necessary dependencies.

```shell
# Navigate to the directory
cd learnstorybook-design-system/

# Install the dependencies
yarn
```

1. **Open the source code and start editing!**

Open the `learnstorybook-design-system` directory in your code editor of choice and building your first component!

## 🔎 What's inside?

A quick look at the top-level files and directories included with this template.

.
├── node_modules
├── public
├── src
├── .gitignore
├── .env
├── LICENSE
├── package.json
├── yarn.lock
└── README.md


1. **`node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages).

2. **`public`**: This directory will contain the development and production build of the site.

3. **`src`**: This directory will contain all of the code related to what you will see on your application.

4. **`.env`**: This file will contain the necessary environment variables for your application.

5. **`.gitignore`**: This file tells git which files it should not track or maintain during the development process of your project.

6. **`LICENSE`**: The template is licensed under the MIT licence.

7. **`package.json`**: Standard manifest file for Node.js projects, which typically includes project specific metadata (such as the project's name, the author among other information). It's based on this file that npm will know which packages are necessary to the project.

8. **`yarn.lock`**: This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(Do not change it manually).**

9. **`README.md`**: A text file containing useful reference information about the project.

## Contribute

If you encounter an issue with the template, we encourage you to open an issue in this template's repository.

## Learning Storybook

1. Read our introductory tutorial over at [Storybook tutorials](https://storybook.js.org/tutorials/intro-to-storybook/react/en/get-started/).
2. Learn how to transform your component libraries into design systems in our [Design Systems for Developers](https://storybook.js.org/tutorials/design-systems-for-developers/) tutorial.
2. See our official documentation at [Storybook](https://storybook.js.org/).