{"id":17040625,"url":"https://github.com/minsoo-web/root-up","last_synced_at":"2025-04-12T14:32:55.527Z","repository":{"id":43464871,"uuid":"464071470","full_name":"minsoo-web/root-up","owner":"minsoo-web","description":"generator for folder by boilerplate template","archived":false,"fork":false,"pushed_at":"2023-02-27T02:28:29.000Z","size":21445,"stargazers_count":13,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T09:36:59.786Z","etag":null,"topics":["cli","generator","npm","npm-package","npx","react"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/root-up","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minsoo-web.png","metadata":{"files":{"readme":"README.ko.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-27T07:45:04.000Z","updated_at":"2024-03-20T17:33:43.000Z","dependencies_parsed_at":"2024-09-24T23:31:05.686Z","dependency_job_id":"d9aca6c9-eb48-4767-bd5c-8cfd66be373e","html_url":"https://github.com/minsoo-web/root-up","commit_stats":null,"previous_names":["minsoo-web/react-component-folder-generator"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minsoo-web%2Froot-up","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minsoo-web%2Froot-up/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minsoo-web%2Froot-up/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minsoo-web%2Froot-up/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minsoo-web","download_url":"https://codeload.github.com/minsoo-web/root-up/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248581160,"owners_count":21128112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","generator","npm","npm-package","npx","react"],"created_at":"2024-10-14T09:10:05.984Z","updated_at":"2025-04-12T14:32:55.493Z","avatar_url":"https://github.com/minsoo-web.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Root Up\n\n![banner](./src/assets/images/banner.png)\n\n[English](https://github.com/minsoo-web/root-up/blob/main/README.md) | 한국어\n\n## 목차\n\n- [🗂 Root Up이 뭔데?](#🗂-root-up이-뭔데)\n- [🚗 설치](#🚗-설치)\n  - [Global](#global)\n  - [Local](#local)\n- [🛑 시작하기 전에](#🛑-시작하기-전에)\n  - [templateFolder](#templateFolder)\n  - [config.json](#config.json)\n- [🚀 실행 방법](#🚀-실행-방법)\n- [🚕 예제](#🚕-예제)\n- [Contributing](#contributing)\n\n## 🗂 Root Up이 뭔데?\n\n`Root Up` 이란, 반복되어 사용되는 폴더 템플릿이 있는 사람들에게 손쉽게 폴더 구조를 생성할 수 있게 해주는 패키지입니다.\n\n## 🚗 설치\n\n### 전역 설치\n\n```bash\n# yarn을 사용할 경우\nyarn global add root-up\n```\n\n```bash\n# npm을 사용할 경우\nnpm install -g root-up\n```\n\n### 로컬 설치\n\n```bash\n# yarn을 사용할 경우\nyarn add -D root-up\n```\n\n```bash\n# npm을 사용할 경우\nnpm install -D root-up\n```\n\n\u003e 주의: 만약 npm 버전 5.0.0 이전의 버전을 사용할 경우 --save 옵션을 꼭 넣어주어야 합니다.\n\n아래와 같이 `package.json`의 scripts에 추가해줍니다.\n\n```json\n\"scripts\": {\n   \"root-up\": \"root-up\"\n},\n```\n\n## 🛑 시작하기 전에\n\n시작하기 전에, 워크스페이스의 루트 경로에 `.template`라는 폴더를 꼭 생성해야 합니다.  \n`.template`폴더는 아래와 같이 구성되어야 합니다.\n\n```txt\n/.template\n   /\u003ctemplateFolder\u003e\n   /\u003ctemplateFolder\u003e\n   ...\n   config.json\n```\n\n[`.template`폴더 예시 확인하기](https://github.com/minsoo-web/root-up/tree/main/.template)\n\n### templateFolder\n\n`/\u003ctemplateFolder\u003e` 은 자주 사용되는 템플릿 폴더입니다.  \nprefix가 제대로 설정되었는지, config.json에 명시되어있는 내용과 일치하는지를 꼭 확인하세요\n\n### config.json\n\n`.config.json` 파일은 다음과 같이 구성되어야 합니다.\n\n```json\n{\n  \"prefix\": \"내가_좋아하는_PREFIX\",\n  \"output\": \"내가_자주_사용하는_output_path\",\n  \"excludePath\": \"내가_무시하고_싶은_folder_name_prefix\"\n}\n```\n\n**prefix**:\n`prefix` 속성은 이름으로 대체되는 속성입니다. 파일의 이름과 코드 내부에서 사용되었을 때,  \n입력된 `name`으로 대체됩니다.\n\n**output**:\n`output` 속성은 템플릿을 통해 생성된 폴더가 위치할 경로를 명시합니다.  \n명령어가 실행된 workspace를 기준으로 상대경로를 명시합니다.\n\n**excludePath**:  \nexcludePath 속성은 생성할 폴더를 검색할 때 무시하고 싶은 폴더 이름을 설정할 수 있습니다.  \n(예를 들면, .yarn 폴더와 같이요!)  \ndefault로 `node_modules`와 `.git`이 설정되어있습니다.\n\n## 🚀 실행 방법\n\n```bash\n# 전역으로 설치된 경우\nroot-up\n\n# 로컬로 설치된 경우\nyarn \u003ccommand\u003e # package.json에 명시된 명령어를 입력합니다.\n```\n\n## 🚕 예제\n\n\u003e npx를 사용할 수도 있습니다.\n\nhttps://user-images.githubusercontent.com/57122180/218425678-eabb9b8d-f7a2-4048-bec1-e32f2da900b0.mov\n\n## Contributing\n\n기여는 언제든지 환영입니다!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminsoo-web%2Froot-up","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminsoo-web%2Froot-up","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminsoo-web%2Froot-up/lists"}