diff --git a/.changeset/README.md b/.changeset/README.md deleted file mode 100644 index e5b6d8d6..00000000 --- a/.changeset/README.md +++ /dev/null @@ -1,8 +0,0 @@ -# Changesets - -Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works -with multi-package repos, or single-package repos to help you version and publish your code. You can -find the full documentation for it [in our repository](https://github.com/changesets/changesets) - -We have a quick list of common questions to get you started engaging with this project in -[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md) diff --git a/.changeset/friendly-countries-love.md b/.changeset/friendly-countries-love.md index 162c3f64..ea8402c5 100644 --- a/.changeset/friendly-countries-love.md +++ b/.changeset/friendly-countries-love.md @@ -3,9 +3,8 @@ "@clab-platforms/land": patch "@clab-platforms/member": patch "@clab-platforms/status": patch -"@clab-platforms/status": patch +"@clab-platforms/time": patch "@clab-platforms/design-system": patch -"@clab-platforms/icon": patch --- chore(*): rename package name diff --git a/.changeset/moody-snakes-crash.md b/.changeset/moody-snakes-crash.md new file mode 100644 index 00000000..524899aa --- /dev/null +++ b/.changeset/moody-snakes-crash.md @@ -0,0 +1,9 @@ +--- +"@clab-platforms/member": patch +"@clab-platforms/status": patch +"@clab-platforms/time": patch +"@clab-platforms/design-system": patch +"@clab-platforms/icon": patch +--- + +feat: setup changeset diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 00000000..0f6e5de4 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,37 @@ +name: Release + +on: + push: + branches: + - main + +concurrency: ${{ github.workflow }}-${{ github.ref }} + +jobs: + release: + name: Release + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Install pnpm + uses: pnpm/action-setup@v3 + with: + version: 8 + run_install: false + + - name: Install Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + cache: 'pnpm' + cache-dependency-path: 'pnpm-lock.yaml' + + - name: Install dependencies + run: pnpm install + + - name: Create Release Pull Request + uses: changesets/action@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.prettierignore b/.prettierignore index 326943f4..3d7fe003 100644 --- a/.prettierignore +++ b/.prettierignore @@ -3,3 +3,6 @@ public dist pnpm-lock.yaml pnpm-workspace.yaml +.changeset/**/*.md +.husky +**/.turbo \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 29ce1447..71fde53c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ GitHub의 이슈는 버그와 개선 사항을 위한 곳입니다. 해당 프 이슈 등록 후 PR을 제출할 수 있어요. 모든 커밋 메시지와 풀 리퀘스트의 제목은 다음 형식을 따라야 해요. -``` +```markdown [optional package scope]: (#) [optional body] diff --git a/README.md b/README.md index a3277787..22b6ea07 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# clab-platforms · [![MIT License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](https://github.com/KGU-C-Lab/clab-platforms/blob/main/LICENSE) [![pnpm CI](https://github.com/KGU-C-Lab/clab-platforms/actions/workflows/pnpm-ci.yml/badge.svg)](https://github.com/KGU-C-Lab/clab-platforms/actions/workflows/pnpm-ci.yml) [![codecov](https://codecov.io/gh/KGU-C-Lab/clab.page/graph/badge.svg?token=Z5PFR6US6Z)](https://codecov.io/gh/KGU-C-Lab/clab.page) +# clab-platforms · [![GitHub License](https://img.shields.io/github/license/KGU-C-Lab/clab-platforms)](https://github.com/KGU-C-Lab/clab-platforms/blob/main/LICENSE) [![pnpm CI](https://github.com/KGU-C-Lab/clab-platforms/actions/workflows/pnpm-ci.yml/badge.svg)](https://github.com/KGU-C-Lab/clab-platforms/actions/workflows/pnpm-ci.yml) [![codecov](https://codecov.io/gh/KGU-C-Lab/clab.page/graph/badge.svg?token=Z5PFR6US6Z)](https://codecov.io/gh/KGU-C-Lab/clab.page) -경기대학교 AI컴퓨터공학부 개발동아리 [C-Lab](https://www.clab.page/)의 공식 프론트엔드 시스템이에요. +[경기대학교 AI컴퓨터공학부 개발동아리 C-Lab](https://www.clab.page/)의 공식 프론트엔드 시스템이에요. 지속적으로 늘어나는 프론트엔드 프로젝트를 유연하고 효율적으로 관리하기 위해 [모노레포(Monorepo)](https://en.wikipedia.org/wiki/Monorepo) 환경으로 만들어졌어요. 해당 프로젝트는 단순히 동아리 내에서 사용할 목적으로 시작되었지만, 그 목표와 가능성은 훨씬 더 넓고 깊은 의미를 지니고 있어요. @@ -18,48 +18,36 @@ ## Apps -![monorepo](https://github.com/KGU-C-Lab/clab-platforms/assets/39869096/fd7756f7-7dde-47fa-8a43-e4fc9b33ecbf) +![monorepo diagram](https://github.com/user-attachments/assets/fae92084-3945-47ee-b1a9-fffad4a09cd9) -> @clab-platforms에 구성되어 있는 프로젝트의 모노레포 구성도예요. 더 자세히 알고 싶다면 해당 프로젝트의 `README.md`를 살펴봐주세요. +> @clab-platforms의 프로젝트 구성도예요. 더 자세히 알고 싶다면 해당 프로젝트의 `README.md`를 살펴봐주세요. -### auth · ![WIP](https://img.shields.io/badge/work_in_progress-black) +### auth · [![Website](https://img.shields.io/website?url=https%3A%2F%2Fauth.clab.page&up_message=online&up_color=black&down_message=offline&down_color=black&label=in%20production&labelColor=black)](https://auth.clab.page/) ![GitHub package.json version](https://img.shields.io/github/package-json/v/KGU-C-Lab/clab-platforms?filename=apps%2Fauth%2Fpackage.json&labelColor=black&color=black) -구성원 계정을 OAuth 프로토콜을 기반으로 서비스에 편리하게 연결할 수 있는 통합 인증 시스템이에요. +구성원 계정을 OAuth 프로토콜을 기반으로 @clab-platforms 서비스를 편리하게 연결할 수 있는 통합 인증 시스템이에요. -### land · ![WIP](https://img.shields.io/badge/work_in_progress-black) +### land · [![Website](https://img.shields.io/website?url=https%3A%2F%2Fwww.clab.page&up_message=online&up_color=black&down_message=offline&down_color=black&label=in%20production&labelColor=black)](https://www.clab.page/) ![GitHub package.json version](https://img.shields.io/github/package-json/v/KGU-C-Lab/clab-platforms?filename=apps%2Fland%2Fpackage.json&labelColor=black&color=black) 모임에 대한 소개, 활동, 블로그 등 다양한 정보를 공유하는 랜딩페이지 시스템이에요. -### [member](https://github.com/KGU-C-Lab/clab-platforms/blob/main/apps/member) · ![WIP](https://img.shields.io/badge/work_in_progress-black) +### [member](https://github.com/KGU-C-Lab/clab-platforms/blob/main/apps/member) · [![Website](https://img.shields.io/website?url=https%3A%2F%2Fplay.clab.page&up_message=online&up_color=black&down_message=offline&down_color=black&label=in%20production&labelColor=black)](https://play.clab.page/) ![GitHub package.json version](https://img.shields.io/github/package-json/v/KGU-C-Lab/clab-platforms?filename=apps%2Fmember%2Fpackage.json&labelColor=black&color=black) -구성원의 활동과 커뮤니케이션을 지원하는 인터널(Internal) 플랫폼이에요. +구성원의 활동과 커뮤니케이션을 지원하는 인터널(Internal) 그룹웨어 시스템이에요. -### status · ![WIP](https://img.shields.io/badge/work_in_progress-black) +### status · ![WIP](https://img.shields.io/badge/work_in_progress-black) ![GitHub package.json version](https://img.shields.io/github/package-json/v/KGU-C-Lab/clab-platforms?filename=apps%2Fstatus%2Fpackage.json&labelColor=black&color=black) -서비스하는 모든 시스템의 상태를 모니터링하고 관리하는 시스템이에요. +서비스 시스템의 상태를 모니터링하고 관리하는 시스템이에요. -### time · ![WIP](https://img.shields.io/badge/work_in_progress-black) +### time · ![WIP](https://img.shields.io/badge/work_in_progress-black) ![GitHub package.json version](https://img.shields.io/github/package-json/v/KGU-C-Lab/clab-platforms?filename=apps%2Ftime%2Fpackage.json&labelColor=black&color=black) -학교 생활에 필요한 정보를 관리하는 플랫폼 시스템이에요. +학교 생활에 필요한 정보를 제공하고 관리하는 플랫폼 시스템이에요. ## Packages -### config - -프로젝트 설정 파일의 일관성을 유지하기 위한 패키지에요. - -### [design-system](https://github.com/KGU-C-Lab/clab-platforms/tree/main/packages/design-system) · ![WIP](https://img.shields.io/badge/work_in_progress-black) +### [design-system](https://github.com/KGU-C-Lab/clab-platforms/tree/main/packages/design-system) · ![WIP](https://img.shields.io/badge/work_in_progress-black) ![GitHub package.json version](https://img.shields.io/github/package-json/v/KGU-C-Lab/clab-platforms?filename=packages%2Fdesign-system%2Fpackage.json&labelColor=black&color=black) 일관성 있는 UI&UX를 위한 디자인 시스템이에요. @clab-platforms의 모든 프로젝트는 해당 디자인 시스템을 사용해요. -### utils - -공통적으로 사용하는 유틸리티 패키지에요. - -### icon - -공통적으로 사용하는 아이콘 패키지에요. - ## Server > Back-end, Server, Infra에 대한 정보는 다른 저장소에서 확인할 수 있어요. @@ -82,7 +70,7 @@
해당 시스템을 참고하거나 자유롭게 사용해도 되나요? - 네, 가능합니다! 이 프로젝트는 GNU 라이센스 하에 배포되어 있으며, 라이센스 조건에 따라 자유롭게 사용하실 수 있습니다. + 네, 가능합니다! 이 프로젝트는 GNU 라이센스 하에 배포되어 있으며, 라이센스 조건에 따라 자유롭게 사용하실 수 있어요.
diff --git a/apps/member/README.md b/apps/member/README.md index 26a56fec..af769e06 100644 --- a/apps/member/README.md +++ b/apps/member/README.md @@ -1,4 +1,4 @@ -# @clab-platforms/member · [![MIT License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](https://github.com/KGU-C-Lab/clab-platforms/blob/main/LICENSE) [![pnpm CI](https://github.com/KGU-C-Lab/clab-platforms/actions/workflows/pnpm-ci.yml/badge.svg)](https://github.com/KGU-C-Lab/clab-platforms/actions/workflows/pnpm-ci.yml) +# @clab-platforms/member · [![Website](https://img.shields.io/website?url=https%3A%2F%2Fplay.clab.page&up_message=online&up_color=black&down_message=offline&down_color=black&label=in%20production&labelColor=black)](https://play.clab.page/) ![GitHub package.json version](https://img.shields.io/github/package-json/v/KGU-C-Lab/clab-platforms?filename=apps%2Fmember%2Fpackage.json&labelColor=black&color=black) 멤버스(Members)는 구성원의 활동과 커뮤니케이션을 지원하는 인터널(Internal) 그룹웨어 시스템이에요. 모임에서 필요한 모든 기능을 제공하며, 구성원들이 손쉽게 활동을 관리하고 소통할 수 있도록 도와줘요. 활동, 일정, 커뮤니티, 도서관, 회비 등 다양한 기능을 제공하고 있어요. diff --git a/apps/status/README.md b/apps/status/README.md deleted file mode 100644 index c4033664..00000000 --- a/apps/status/README.md +++ /dev/null @@ -1,36 +0,0 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). - -## Getting Started - -First, run the development server: - -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` - -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. - -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. - -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. diff --git a/apps/status/package.json b/apps/status/package.json index d8c10bf0..7b0fd976 100644 --- a/apps/status/package.json +++ b/apps/status/package.json @@ -10,14 +10,14 @@ "type": "tsc --noEmit" }, "dependencies": { - "@clab-platforms/utils": "workspace:^", + "@clab-platforms/utils": "workspace:*", "next": "14.2.4", "react": "^18", "react-dom": "^18", "react-lottie-player": "^2.0.0" }, "devDependencies": { - "@clab-platforms/config": "workspace:^", + "@clab-platforms/config": "workspace:*", "@types/node": "^20", "@types/react": "^18", "@types/react-dom": "^18", diff --git a/apps/time/README.md b/apps/time/README.md deleted file mode 100644 index dc3a17f0..00000000 --- a/apps/time/README.md +++ /dev/null @@ -1 +0,0 @@ -# Time diff --git a/apps/time/package.json b/apps/time/package.json index bc476979..0e95e3c1 100644 --- a/apps/time/package.json +++ b/apps/time/package.json @@ -1,5 +1,5 @@ { - "name": "@clab-platforms/kgu-plus", + "name": "@clab-platforms/time", "version": "0.1.0", "private": true, "scripts": { diff --git a/packages/design-system/README.md b/packages/design-system/README.md index 8763bed2..58bd4da5 100644 --- a/packages/design-system/README.md +++ b/packages/design-system/README.md @@ -1,4 +1,4 @@ -# @clab-platforms/design-system · [![MIT License](https://img.shields.io/badge/license-GPL--3.0-blue.svg)](https://github.com/KGU-C-Lab/clab-platforms/blob/main/LICENSE) [![pnpm CI](https://github.com/KGU-C-Lab/clab-platforms/actions/workflows/pnpm-ci.yml/badge.svg)](https://github.com/KGU-C-Lab/clab-platforms/actions/workflows/pnpm-ci.yml) [![codecov](https://codecov.io/gh/KGU-C-Lab/clab.page/graph/badge.svg?token=Z5PFR6US6Z)](https://codecov.io/gh/KGU-C-Lab/clab.page) +# @clab-platforms/design-system · ![WIP](https://img.shields.io/badge/work_in_progress-black) ![GitHub package.json version](https://img.shields.io/github/package-json/v/KGU-C-Lab/clab-platforms?filename=packages%2Fdesign-system%2Fpackage.json&labelColor=black&color=black) C-Lab Design System(CDS)은 동아리의 모든 프로젝트에 일관된 디자인을 적용하기 위해 개발된 통합 디자인 시스템이에요. CDS는 동아리 내에서 사용할 목적으로 개발되었지만, 차기 버전은 지금의 모습보다 더욱 고도화하여 외부에서도 사용할 수 있도록 배포할 예정이에요. diff --git a/packages/design-system/package.json b/packages/design-system/package.json index aac70763..be0a3f98 100644 --- a/packages/design-system/package.json +++ b/packages/design-system/package.json @@ -17,6 +17,9 @@ "build-storybook": "storybook build", "build": "./build.bash" }, + "dependencies": { + "@clab-platforms/icon": "workspace:*" + }, "devDependencies": { "@chromatic-com/storybook": "^1.3.4", "@clab-platforms/config": "workspace:*", @@ -52,8 +55,5 @@ "peerDependencies": { "react": "^18.2.0", "react-dom": "^18.2.0" - }, - "dependencies": { - "@clab-platforms/icon": "workspace:*" } } diff --git a/packages/icon/package.json b/packages/icon/package.json index db0214ae..64a66686 100644 --- a/packages/icon/package.json +++ b/packages/icon/package.json @@ -1,6 +1,5 @@ { "name": "@clab-platforms/icon", - "version": "0.1.0", "private": true, "main": "src/index.ts", "scripts": { diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 92b01da9..8f7096fe 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -297,7 +297,7 @@ importers: apps/status: dependencies: '@clab-platforms/utils': - specifier: workspace:^ + specifier: workspace:* version: link:../../packages/utils next: specifier: 14.2.4 @@ -313,7 +313,7 @@ importers: version: 2.0.0(react@18.2.0) devDependencies: '@clab-platforms/config': - specifier: workspace:^ + specifier: workspace:* version: link:../../packages/config '@types/node': specifier: ^20