feat: Design (#1)

Author: darioAnongba

.eslintignore

@@ -0,0 +1,48 @@
+# Build directories
+
+build/_
+dist/_
+public/_
+\*\*/out/_
+**/.next/\*
+**/node_modules/\*
+
+# src/
+
+**/reportWebVitals.\*
+**/service-worker._
+\*\*/serviceWorkerRegistration._ \*_/setupTests._
+
+# eslintrc
+
+\*_/.eslintrc._
+
+# prettier
+
+**/.prettier.\*
+**/prettier.config.\*
+
+# next
+
+\*_/next.config._
+
+# vite
+
+\*_/vite.config._
+
+# tailwind
+
+**/postcss.config.\*
+**/tailwind.config.\*
+
+# craco
+
+\*_/craco.config._
+
+# misc
+
+\*\*/jsconfig.json
+
+# openapi
+
+src/lib/swissknife/types.gen.ts

.eslintrc.js

@@ -0,0 +1,109 @@
+/**
+ *  @type {import('eslint').ESLint.ConfigData}
+ */
+module.exports = {
+  root: true,
+  env: { browser: true, es2020: true },
+  plugins: ['perfectionist', 'unused-imports', '@typescript-eslint', 'prettier'],
+  extends: ['airbnb', 'airbnb-typescript', 'airbnb/hooks', 'prettier'],
+  parserOptions: {
+    sourceType: 'module',
+    ecmaVersion: 'latest',
+    ecmaFeatures: { jsx: true },
+    project: './tsconfig.json',
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {
+        project: './tsconfig.json',
+      },
+    },
+  },
+  /**
+   * 0 ~ 'off'
+   * 1 ~ 'warn'
+   * 2 ~ 'error'
+   */
+  rules: {
+    // general
+    'no-alert': 0,
+    camelcase: 0,
+    'no-console': 0,
+    'no-unused-vars': 0,
+    'no-nested-ternary': 0,
+    'no-param-reassign': 0,
+    'no-underscore-dangle': 0,
+    'no-restricted-exports': 0,
+    'no-promise-executor-return': 0,
+    'import/prefer-default-export': 0,
+    'prefer-destructuring': [1, { object: true, array: false }],
+    // typescript
+    '@typescript-eslint/naming-convention': 0,
+    '@typescript-eslint/no-use-before-define': 0,
+    '@typescript-eslint/consistent-type-exports': 1,
+    '@typescript-eslint/consistent-type-imports': 1,
+    '@typescript-eslint/no-unused-vars': [1, { args: 'none' }],
+    // react
+    'react/no-children-prop': 0,
+    'react/react-in-jsx-scope': 0,
+    'react/no-array-index-key': 0,
+    'react/require-default-props': 0,
+    'react/jsx-props-no-spreading': 0,
+    'react/function-component-definition': 0,
+    'react/jsx-no-useless-fragment': [1, { allowExpressions: true }],
+    'react/no-unstable-nested-components': [1, { allowAsProps: true }],
+    'react/jsx-no-duplicate-props': [1, { ignoreCase: false }],
+    // jsx-a11y
+    'jsx-a11y/anchor-is-valid': 0,
+    'jsx-a11y/control-has-associated-label': 0,
+    // unused imports
+    'unused-imports/no-unused-imports': 1,
+    'unused-imports/no-unused-vars': [
+      0,
+      { vars: 'all', varsIgnorePattern: '^_', args: 'after-used', argsIgnorePattern: '^_' },
+    ],
+    // perfectionist
+    'perfectionist/sort-exports': [1, { order: 'asc', type: 'line-length' }],
+    'perfectionist/sort-named-imports': [1, { order: 'asc', type: 'line-length' }],
+    'perfectionist/sort-named-exports': [1, { order: 'asc', type: 'line-length' }],
+    'perfectionist/sort-imports': [
+      1,
+      {
+        order: 'asc',
+        type: 'line-length',
+        'newlines-between': 'always',
+        groups: [
+          'style',
+          'type',
+          ['builtin', 'external'],
+          'custom-mui',
+          'custom-routes',
+          'custom-hooks',
+          'custom-utils',
+          'internal',
+          'custom-components',
+          'custom-sections',
+          'custom-auth',
+          'custom-types',
+          ['parent', 'sibling', 'index'],
+          ['parent-type', 'sibling-type', 'index-type'],
+          'object',
+          'unknown',
+        ],
+        'custom-groups': {
+          value: {
+            ['custom-mui']: '@mui/**',
+            ['custom-auth']: 'src/auth/**',
+            ['custom-hooks']: 'src/hooks/**',
+            ['custom-utils']: 'src/utils/**',
+            ['custom-types']: 'src/types/**',
+            ['custom-routes']: 'src/routes/**',
+            ['custom-sections']: 'src/sections/**',
+            ['custom-components']: 'src/components/**',
+          },
+        },
+        'internal-pattern': ['src/**'],
+      },
+    ],
+  },
+};

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,34 @@
+name: Bug Report
+description: Create a report to help us improve
+labels: ['bug']
+body:
+  - type: textarea
+    id: issue-description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+      placeholder: Describe the bug here.
+    validations:
+      required: true
+  - type: textarea
+    id: issue-reproduction
+    attributes:
+      label: Steps to reproduce
+      description: Describe steps to reproduce the behavior.
+      placeholder: Steps to reproduce the bug here.
+    validations:
+      required: true
+  - type: textarea
+    id: expected-behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: Expected behavior here.
+    validations:
+      required: true
+  - type: textarea
+    id: screenshots
+    attributes:
+      label: Screenshots
+      description: If applicable, add screenshots to help explain your problem.
+      placeholder: Add screenshots here.

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: Lint, Prettier and Build
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint-and-prettier:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Install dependencies
+        run: yarn install
+
+      - name: Run ESLint
+        run: yarn lint
+
+      - name: Run Prettier
+        run: yarn fm:check
+
+      - name: Run build
+        run: yarn build