From 4057c364451a005cf7f6b49ca27e368e9c947b2d Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 15:05:22 +0545 Subject: [PATCH 01/24] Test: Fix1 Move workflow to root folder --- {apps/docs/.github => .github}/workflows/main.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {apps/docs/.github => .github}/workflows/main.yml (100%) diff --git a/apps/docs/.github/workflows/main.yml b/.github/workflows/main.yml similarity index 100% rename from apps/docs/.github/workflows/main.yml rename to .github/workflows/main.yml From 674695bf2ac48f5375ec2bffbba79f714747146b Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 15:30:47 +0545 Subject: [PATCH 02/24] Fix2: workflow --- .github/workflows/main.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1a7f618..62e0b04 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -18,13 +18,14 @@ jobs: run: npm install - name: Build App + working-directory: apps/docs run: npm run build - name: Deploy to Vercel uses: amondnet/vercel-action@v20 with: vercel-token: ${{ secrets.VERCEL_TOKEN }} - vercel-args: --yes + vercel-args: --yes --prod --include=apps/docs/** - name: Wait for Deployment run: | From 82ec98acf7de2e0b6cf25dc4d5397dcf27d9ef85 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 15:41:52 +0545 Subject: [PATCH 03/24] Fix3: Deployement workflow --- .github/workflows/main.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 62e0b04..60205c2 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -15,17 +15,17 @@ jobs: node-version: 16.x - name: Install Dependencies - run: npm install + run: yarn - name: Build App working-directory: apps/docs - run: npm run build + run: yarn workspace docs run build - name: Deploy to Vercel uses: amondnet/vercel-action@v20 with: vercel-token: ${{ secrets.VERCEL_TOKEN }} - vercel-args: --yes --prod --include=apps/docs/** + vercel-args: --yes - name: Wait for Deployment run: | From a1742e905c0123500f632e92923cdd7d287e59c5 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 16:35:04 +0545 Subject: [PATCH 04/24] Update main.yml --- .github/workflows/main.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 60205c2..91f38ae 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -23,6 +23,7 @@ jobs: - name: Deploy to Vercel uses: amondnet/vercel-action@v20 + working-directory: apps/docs with: vercel-token: ${{ secrets.VERCEL_TOKEN }} vercel-args: --yes From 406b7c968f30863393f2fbcd87ef36d2ce1a37a2 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 16:38:46 +0545 Subject: [PATCH 05/24] Fix4: Deployement workflow --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 91f38ae..2d3ee43 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -21,7 +21,7 @@ jobs: working-directory: apps/docs run: yarn workspace docs run build - - name: Deploy to Vercel + - name: Deploy apps/docs to Vercel uses: amondnet/vercel-action@v20 working-directory: apps/docs with: From f27117e9c0e7c5508e60c2929921a7c28e2ee188 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 16:40:27 +0545 Subject: [PATCH 06/24] Fix5: Deployement workflow --- .github/workflows/main.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 2d3ee43..bb911a4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -23,10 +23,9 @@ jobs: - name: Deploy apps/docs to Vercel uses: amondnet/vercel-action@v20 - working-directory: apps/docs with: vercel-token: ${{ secrets.VERCEL_TOKEN }} - vercel-args: --yes + vercel-args: --yes --prod --include=apps/docs/** - name: Wait for Deployment run: | From 8ba2321fb997b3428e28f88edc843d6f068d510e Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 16:46:23 +0545 Subject: [PATCH 07/24] Update main.yml --- .github/workflows/main.yml | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bb911a4..d8cc072 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -20,12 +20,15 @@ jobs: - name: Build App working-directory: apps/docs run: yarn workspace docs run build - + - name: Deploy apps/docs to Vercel uses: amondnet/vercel-action@v20 with: vercel-token: ${{ secrets.VERCEL_TOKEN }} - vercel-args: --yes --prod --include=apps/docs/** + vercel-args: --prod --yes + run: | + cd apps/docs/ + vercel - name: Wait for Deployment run: | From 45fbda5f3c17712e55d95f3e1698631a1fd4ed5d Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 16:52:36 +0545 Subject: [PATCH 08/24] Fix9: Deployement workflow --- .github/workflows/main.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index d8cc072..46eecb0 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -20,15 +20,13 @@ jobs: - name: Build App working-directory: apps/docs run: yarn workspace docs run build - + - name: Deploy apps/docs to Vercel uses: amondnet/vercel-action@v20 with: vercel-token: ${{ secrets.VERCEL_TOKEN }} vercel-args: --prod --yes - run: | - cd apps/docs/ - vercel + working-directory: apps/docs/** - name: Wait for Deployment run: | From a33ac82e9438827af26e15da5973cc88ad5c544a Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 16:57:38 +0545 Subject: [PATCH 09/24] Fix-10: Deployement workflow --- .github/workflows/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 46eecb0..1fafc28 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -25,8 +25,8 @@ jobs: uses: amondnet/vercel-action@v20 with: vercel-token: ${{ secrets.VERCEL_TOKEN }} - vercel-args: --prod --yes - working-directory: apps/docs/** + vercel-args: --yes + working-directory: apps/docs/ - name: Wait for Deployment run: | From 08a6e094a9ceaac41d9fb745b0876b2e196fdb3c Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 17:11:25 +0545 Subject: [PATCH 10/24] Fix-11: Deployement workflow --- apps/docs/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/package.json b/apps/docs/package.json index 7ff3ba8..2cbe61f 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -4,7 +4,7 @@ "private": true, "scripts": { "dev": "next dev --port 3001", - "build": "next build", + "build": "yarn workspace docs run build", "start": "next start", "lint": "next lint", "test:lighthouse": "yarn run build && lhci autorun" From 9db7a7859f1a39cc426dd6876b93d52dc50be29a Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 17:21:54 +0545 Subject: [PATCH 11/24] Fix-12: Deployement workflow --- apps/docs/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/package.json b/apps/docs/package.json index 2cbe61f..7ff3ba8 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -4,7 +4,7 @@ "private": true, "scripts": { "dev": "next dev --port 3001", - "build": "yarn workspace docs run build", + "build": "next build", "start": "next start", "lint": "next lint", "test:lighthouse": "yarn run build && lhci autorun" From 86b3c02daa702939c78876964706070ba9f13483 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 17:26:20 +0545 Subject: [PATCH 12/24] Fix-13: Deployement workflow --- .github/workflows/main.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1fafc28..bebd1ee 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -26,7 +26,6 @@ jobs: with: vercel-token: ${{ secrets.VERCEL_TOKEN }} vercel-args: --yes - working-directory: apps/docs/ - name: Wait for Deployment run: | From 9a9e62ce7f938d8543446098817f8591113d479a Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 17:42:55 +0545 Subject: [PATCH 13/24] Fix-14: Deployement workflow --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bebd1ee..c2ac614 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -17,7 +17,7 @@ jobs: - name: Install Dependencies run: yarn - - name: Build App + - name: Build App -- But do you we need to build here? working-directory: apps/docs run: yarn workspace docs run build From 3bded9fce8e9d2d8b579969240ee5fee19304ce7 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Fri, 21 Apr 2023 17:53:07 +0545 Subject: [PATCH 14/24] Fix-15: Deployement workflow --- apps/docs/next.config.js | 1 + 1 file changed, 1 insertion(+) diff --git a/apps/docs/next.config.js b/apps/docs/next.config.js index fdda6aa..ce57260 100644 --- a/apps/docs/next.config.js +++ b/apps/docs/next.config.js @@ -1,4 +1,5 @@ module.exports = { reactStrictMode: true, transpilePackages: ["ui"], + distDir: "apps/docs/.next", }; From 16da0f148b00bb8a1af13983151bc5b6e344258b Mon Sep 17 00:00:00 2001 From: Your Name Date: Mon, 24 Apr 2023 12:04:33 +0545 Subject: [PATCH 15/24] add yarn run build command --- .github/workflows/main.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index c2ac614..4b2098a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -19,7 +19,8 @@ jobs: - name: Build App -- But do you we need to build here? working-directory: apps/docs - run: yarn workspace docs run build + #run: yarn workspace docs run build + run: yarn run build - name: Deploy apps/docs to Vercel uses: amondnet/vercel-action@v20 From 3365cdba4876e7d32b76c1c374b142dcd263a56f Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Mon, 24 Apr 2023 12:14:43 +0545 Subject: [PATCH 16/24] Update main.yml - Only build in vercel --- .github/workflows/main.yml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4b2098a..6151ebe 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -9,18 +9,18 @@ jobs: - name: Checkout Code uses: actions/checkout@v3 - - name: Use Node.js 16.x - uses: actions/setup-node@v3 - with: - node-version: 16.x - - - name: Install Dependencies - run: yarn - - - name: Build App -- But do you we need to build here? - working-directory: apps/docs - #run: yarn workspace docs run build - run: yarn run build +# - name: Use Node.js 16.x +# uses: actions/setup-node@v3 +# with: +# node-version: 16.x + +# - name: Install Dependencies +# run: yarn + +# - name: Build App -- But do you we need to build here? +# working-directory: apps/docs +# #run: yarn workspace docs run build +# run: yarn run build - name: Deploy apps/docs to Vercel uses: amondnet/vercel-action@v20 From b47e2ea390e78a5808ebe5ec6e2cd2da8bffe63b Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Mon, 24 Apr 2023 12:22:19 +0545 Subject: [PATCH 17/24] Update main.yml --- .github/workflows/main.yml | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 6151ebe..4b2098a 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -9,18 +9,18 @@ jobs: - name: Checkout Code uses: actions/checkout@v3 -# - name: Use Node.js 16.x -# uses: actions/setup-node@v3 -# with: -# node-version: 16.x - -# - name: Install Dependencies -# run: yarn - -# - name: Build App -- But do you we need to build here? -# working-directory: apps/docs -# #run: yarn workspace docs run build -# run: yarn run build + - name: Use Node.js 16.x + uses: actions/setup-node@v3 + with: + node-version: 16.x + + - name: Install Dependencies + run: yarn + + - name: Build App -- But do you we need to build here? + working-directory: apps/docs + #run: yarn workspace docs run build + run: yarn run build - name: Deploy apps/docs to Vercel uses: amondnet/vercel-action@v20 From 4fa302e94f70bb581340323ac6bd3d5045e30cb9 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Mon, 24 Apr 2023 12:36:48 +0545 Subject: [PATCH 18/24] Fix-19: Deployement workflow --- turbo.json | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/turbo.json b/turbo.json index 44425e0..ef4a0a2 100644 --- a/turbo.json +++ b/turbo.json @@ -1,10 +1,17 @@ { "$schema": "https://turbo.build/schema.json", - "globalDependencies": ["**/.env.*local"], + "globalDependencies": [ + "**/.env.*local" + ], "pipeline": { "build": { - "dependsOn": ["^build"], - "outputs": ["dist/**", ".next/**"] + "dependsOn": [ + "^build" + ], + "outputs": [ + ".next/**", + "!.next/cache/**" + ] }, "lint": { "outputs": [] @@ -13,4 +20,4 @@ "cache": false } } -} +} \ No newline at end of file From 771c8a1ed77791c49e20e08690d0b03405f81289 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Mon, 24 Apr 2023 13:37:32 +0545 Subject: [PATCH 19/24] Update main.yml --- .github/workflows/main.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 4b2098a..7788543 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -27,6 +27,8 @@ jobs: with: vercel-token: ${{ secrets.VERCEL_TOKEN }} vercel-args: --yes + build-dir: apps/docs/.next + - name: Wait for Deployment run: | From 0800d0eb6d8aee70532b95f6870491d0051ef365 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Mon, 24 Apr 2023 14:01:27 +0545 Subject: [PATCH 20/24] Fix-20: Deployement workflow --- apps/docs/next.config.js | 1 - 1 file changed, 1 deletion(-) diff --git a/apps/docs/next.config.js b/apps/docs/next.config.js index ce57260..fdda6aa 100644 --- a/apps/docs/next.config.js +++ b/apps/docs/next.config.js @@ -1,5 +1,4 @@ module.exports = { reactStrictMode: true, transpilePackages: ["ui"], - distDir: "apps/docs/.next", }; From 084adda13f22d73ba48954db2c282e681f1a173f Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Mon, 24 Apr 2023 14:09:02 +0545 Subject: [PATCH 21/24] Add preview links --- apps/docs/lighthouserc.js | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/apps/docs/lighthouserc.js b/apps/docs/lighthouserc.js index 4ac326f..830bd0b 100644 --- a/apps/docs/lighthouserc.js +++ b/apps/docs/lighthouserc.js @@ -1,8 +1,13 @@ module.exports = { ci: { collect: { - url: 'http://localhost:3001', - startServerCommand: 'yarn run dev', + // Use this for Prod / dev + url: [ + `https://${process.env.PREVIEW_URL}`, + ], + // url: 'http://localhost:3001', + startServerCommand: + process.env.NODE_ENV === 'production' ? undefined : 'npm run start', }, assert: { preset: 'lighthouse:no-pwa', @@ -12,4 +17,3 @@ module.exports = { }, }, }; - From 56410f9d337904fe976d80dafa52ac14d50cd716 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Mon, 24 Apr 2023 14:22:23 +0545 Subject: [PATCH 22/24] Fix A1: configurations --- .github/workflows/main.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 7788543..bf22782 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -29,7 +29,6 @@ jobs: vercel-args: --yes build-dir: apps/docs/.next - - name: Wait for Deployment run: | echo "Waiting for deployment to finish..." @@ -40,8 +39,9 @@ jobs: - name: Run Lighthouse Tests run: | + cd apps/docs npm install -g @lhci/cli@0.11.x - lhci autorun + lhci autorun --config apps/docs/lighthouserc.js env: LHCI_GITHUB_APP_TOKEN: ${{ secrets.LHCI_GITHUB_APP_TOKEN }} From aad687d6a9c3847653e07485dbbd0fec07412f72 Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Mon, 24 Apr 2023 14:27:17 +0545 Subject: [PATCH 23/24] Fix A2: configurations --- .github/workflows/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index bf22782..b6879db 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -41,7 +41,7 @@ jobs: run: | cd apps/docs npm install -g @lhci/cli@0.11.x - lhci autorun --config apps/docs/lighthouserc.js + lhci autorun env: LHCI_GITHUB_APP_TOKEN: ${{ secrets.LHCI_GITHUB_APP_TOKEN }} From 4745a3286b5c5b40335ade69302fbaedc31e4f3b Mon Sep 17 00:00:00 2001 From: Sanjeeb Lama <51410633+SanjeebLama@users.noreply.github.com> Date: Wed, 3 May 2023 13:20:23 +0545 Subject: [PATCH 24/24] Update README.md --- README.md | 189 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 189 insertions(+) diff --git a/README.md b/README.md index 7a5f447..0f1da3e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ [![Jira](https://badgen.net/badge/icon/jira?icon=jira&label)](https://github.com/SanjeebLama/Frontend-Skeleton) [![](https://img.shields.io/badge/Documentation-darkblue?style=flat&logo=notion&logoWidth=20&logoHeight=20)](https://github.com/SanjeebLama/Frontend-Skeleton) + # 🚀 Turbo Frontend Skeleton Turbo Frontend Skeleton is a template designed to help streamline the process of creating new frontend projects. It comes equipped with all the latest stable dependencies that we use, allowing developers to get up and running quickly. @@ -45,7 +46,195 @@ This turborepo has some additional tools already setup for you: | TypeScript | A strict syntactical superset of JavaScript | | ESLint | A pluggable linting utility for JavaScript and JSX | | Prettier | An opinionated code formatter | + + +#### Project Tree + + ``` +frontend-skeleton +├─ .vscode +│ └─ settings.json +├─ apps +│ ├─ docs +│ │ ├─ .eslintrc.js +│ │ ├─ README.md +│ │ ├─ next-env.d.ts +│ │ ├─ next.config.js +│ │ ├─ package.json +│ │ ├─ pages +│ │ │ ├─ _app.tsx +│ │ │ └─ index.tsx +│ │ ├─ postcss.config.js +│ │ ├─ styles +│ │ │ └─ globals.css +│ │ ├─ tailwind.config.js +│ │ └─ tsconfig.json +│ └─ web +│ ├─ .eslintrc.js +│ ├─ .lighthouseci +│ ├─ README.md +│ ├─ next-env.d.ts +│ ├─ next-i18next.config.js +│ ├─ next.config.js +│ ├─ package.json +│ ├─ pages +│ │ ├─ _app.tsx +│ │ ├─ _error.tsx +│ │ ├─ api +│ │ │ ├─ axios +│ │ │ │ └─ index.tsx +│ │ │ └─ error.tsx +│ │ ├─ index.tsx +│ │ └─ playground +│ │ ├─ axios +│ │ │ └─ index.tsx +│ │ ├─ index.tsx +│ │ ├─ react-form +│ │ │ └─ index.tsx +│ │ └─ users +│ │ └─ index.tsx +│ ├─ postcss.config.js +│ ├─ public +│ │ └─ static +│ │ ├─ assets +│ │ │ ├─ Axios.png +│ │ │ ├─ axios_example.png +│ │ │ ├─ i18-example.png +│ │ │ ├─ react-hook-form.png +│ │ │ └─ react-query-fetch.png +│ │ └─ locales +│ │ ├─ en +│ │ │ └─ common.json +│ │ └─ ja +│ │ └─ common.json +│ ├─ sentry.client.config.js +│ ├─ sentry.edge.config.js +│ ├─ sentry.server.config.js +│ ├─ services +│ │ ├─ axios.ts +│ │ └─ index.ts +│ ├─ styles +│ │ └─ globals.css +│ ├─ tailwind.config.js +│ └─ tsconfig.json +├─ package.json +├─ packages +│ ├─ next-i18next-config +│ │ ├─ next-i18next.config.js +│ │ └─ package.json +│ ├─ eslint-config-custom +│ │ ├─ index.js +│ │ └─ package.json +│ ├─ tailwind-config +│ │ ├─ package.json +│ │ ├─ postcss.config.js +│ │ └─ tailwind.config.js +│ ├─ tsconfig +│ │ ├─ README.md +│ │ ├─ base.json +│ │ ├─ nextjs.json +│ │ ├─ package.json +│ │ └─ react-library.json +│ └─ ui +│ ├─ .babelrc.json +│ ├─ .storybook +│ │ ├─ main.js +│ │ └─ preview.js +│ ├─ components +│ │ ├─ atoms +│ │ │ ├─ Axios +│ │ │ │ ├─ Drawer +│ │ │ │ │ └─ index.tsx +│ │ │ │ ├─ Modal +│ │ │ │ │ └─ index.tsx +│ │ │ │ ├─ Table +│ │ │ │ │ └─ index.tsx +│ │ │ │ └─ index.tsx +│ │ │ ├─ CustomDatePicker +│ │ │ │ └─ index.tsx +│ │ │ ├─ CustomInput +│ │ │ │ └─ index.tsx +│ │ │ ├─ CustomPasswordInput +│ │ │ │ └─ index.tsx +│ │ │ ├─ CustomSelect +│ │ │ │ └─ index.tsx +│ │ │ ├─ CustomizableButton +│ │ │ │ └─ index.tsx +│ │ │ ├─ DocumentationButton +│ │ │ │ └─ index.tsx +│ │ │ ├─ NumberInput +│ │ │ │ └─ index.tsx +│ │ │ ├─ RequiredIcon +│ │ │ │ └─ index.tsx +│ │ │ ├─ StoryButton +│ │ │ │ ├─ StoryButton.stories.tsx +│ │ │ │ └─ index.tsx +│ │ │ ├─ TechStackInfo +│ │ │ │ └─ index.tsx +│ │ │ └─ index.ts +│ │ ├─ index.ts +│ │ ├─ molecules +│ │ │ └─ index.ts +│ │ └─ organisms +│ │ └─ index.ts +│ ├─ index.tsx +│ ├─ package.json +│ ├─ postcss.config.js +│ ├─ stories +│ │ ├─ Button.stories.tsx +│ │ ├─ Button.tsx +│ │ ├─ Header.stories.tsx +│ │ ├─ Header.tsx +│ │ ├─ Introduction.stories.mdx +│ │ ├─ Page.stories.tsx +│ │ ├─ Page.tsx +│ │ ├─ assets +│ │ │ ├─ code-brackets.svg +│ │ │ ├─ colors.svg +│ │ │ ├─ comments.svg +│ │ │ ├─ direction.svg +│ │ │ ├─ flow.svg +│ │ │ ├─ plugin.svg +│ │ │ ├─ repo.svg +│ │ │ └─ stackalt.svg +│ │ ├─ button.css +│ │ ├─ header.css +│ │ └─ page.css +│ ├─ styles +│ │ └─ globals.css +│ ├─ tailwind.config.js +│ ├─ tsconfig.json +│ └─ types +│ ├─ FormData.tsx +│ └─ index.tsx +├─ .eslintrc.js +├─ .git +├─ .gitignore +├─ .nvmrc +├─ .prettierrc +├─ README.md +├─ turbo.json +└─ yarn.lock + +``` + +**Atomic Design System for Component Development** + - Atomic Design System is a methodology for creating design systems by breaking down the UI into fundamental building blocks called atoms, molecules, and organisms. + - Atoms are the smallest and most basic building blocks, molecules are groups of atoms that work together to form more complex and functional components, and organisms are groups of molecules and atoms that work together to form a more complete section or module of the interface. + - By using Atomic Design System, designers and developers can create scalable, reusable, and consistent components that can be easily maintained and updated. + - This approach promotes a more efficient and collaborative design process by providing a common language and framework for designers and developers to work with, while delivering high-quality and user-friendly experiences. + + +** Naming Convention** + - Use a consistent and descriptive naming convention across all projects and components within the mono repo. + - Avoid using ambiguous or generic names that could create confusion or conflicts with other projects or components within the mono repo. + - Package names should be descriptive and easy to remember. For example, a package that contains code for a web server might be named my-web-server. + - Directory names should be similar to package names, but they should be more specific. For example, the directory that contains the code for the web server's main logic might be named src/web-server. + - File names should be descriptive and include the name of the file's contents. For example, a file that contains the code for the web server's main logic might be named main.js. + - Consider using a versioning scheme in the naming convention to indicate the version of the project or component (e.g., "app-v1.0", "lib-v2.3", "ui-v1.2.3", etc.). + +

⬆️