Initial commit

.eslintrc.json

@@ -0,0 +1,31 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:react/recommended",
+    "plugin:@typescript-eslint/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["react", "react-hooks", "@typescript-eslint"],
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "rules": {
+    "react/react-in-jsx-scope": "off",
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn",
+    "no-restricted-imports": [
+      "error",
+      {
+        "patterns": ["@mui/*/*/*"]
+      }
+    ]
+  }
+}

.github/FUNDING.yml

@@ -0,0 +1,13 @@
+# These are supported funding model platforms
+
+github: [suren-atoyan]
+patreon: suren_atoyan
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/workflows/analyses.yml

@@ -0,0 +1,71 @@
+name: analyses
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+jobs:
+  install:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Dependencies
+        run: npm ci
+      - name: Cache node modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ github.sha }}
+
+  lint:
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cached node modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ github.sha }}
+      - name: Eslint
+        run: npm run lint:check
+
+  prettier:
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cached node modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ github.sha }}
+      - name: Prettier
+        run: npm run prettier:check
+
+  typescript:
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cached node modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ github.sha }}
+      - name: Typescript
+        run: npm run ts:check
+
+  unit_tests:
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Cached node modules
+        uses: actions/cache@v2
+        with:
+          path: node_modules
+          key: ${{ github.sha }}
+      - name: Unit tests
+        run: npm run test:unit

.github/workflows/tests:e2e.yml

@@ -0,0 +1,27 @@
+name: e2e tests
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+jobs:
+  test:
+    timeout-minutes: 60
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Install dependencies
+        run: npm ci
+      - name: Install Playwright Browsers
+        run: npx playwright install --with-deps
+      - name: Run Playwright tests
+        run: npm run test:e2e
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: playwright-report
+          path: playwright-report/
+          retention-days: 30

.gitignore

@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dev-dist
+dist-ssr
+*.local
+.env
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# TODO (Suren): Add more tests
+npx lint-staged

.prettierrc.json

@@ -0,0 +1,18 @@
+{
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "all",
+  "importOrder": [
+    "^(^react$|@react|react|^recoil$)",
+    "^@mui/(.*)$",
+    "<THIRD_PARTY_MODULES>",
+    "^@/(.*)$",
+    "^[./]"
+  ],
+  "importOrderGroupNamespaceSpecifiers": true,
+  "importOrderSeparation": true,
+  "importOrderSortSpecifiers": true
+}

CHANGELOG.md

@@ -0,0 +1,99 @@
+### Releases
+
+## v2.3.0
+
+###### _Dec 23, 2023_
+
+- packages: update all packages
+- env: add environmental variables
+- tests: add unit tests (`vitest`) and e2e tests (`playwright`)
+- github actions: add github actions
+
+## v2.2.0
+
+###### _Dec 23, 2023_
+
+- packages: update all packages
+  - Vite 5 ✅
+- replace `Alt + /` with `Alt + k` (there was an issue with detecting `/`)
+
+## v2.1.0
+
+###### _Oct 29, 2022_
+
+- packages: update all packages
+  - Vite 3 ✅
+
+## v2.0.2
+
+###### _May 28, 2022_
+
+- packages: update all packages
+- hotkeys: fix hotkeys' names
+
+## v2.0.1
+
+###### _Apr 18, 2022_
+
+- packages: update `vite-plugin-pwa` to v0.11.3
+- hotkeys: fix hotkeys' handlers
+- dev-tool: add welcome message in the console
+
+## v2.0.0
+
+###### _Apr 18, 2022_
+
+- ✅ Vite
+- ✅ React v18
+- ✅ TypeScript
+- ✅ React Router v6
+- ✅ MUI v5
+- ✅ eslint
+- ✅ prettier
+- ✅ husky
+- ✅ lint-staged
+- ✅ https localhost
+
+## v1.1.0
+
+###### _Dec 6, 2020_
+
+- package.json: update `recoil` version to 0.1.2
+- components:
+  - Divider: add property `withoutMargins`, change margins based on `orientation`
+  - Loading: add first class property `position`
+  - NotFound: add 404 gif from `giphy`, move from `Box` to `Fb`
+  - Link: fix `export default` style
+  - Fb: create flexbox component, replace all `Box` components with `Fb`
+- utils: remove single entry point, use only direct paths for utils
+- store: use atom effects in theme, style corrections
+
+## v1.0.2
+
+###### _Sep 7, 2020_
+
+- lint: update eslint rules (make correction according to new rules)
+- checks: add husky (pre-commit -> lint)
+
+## v1.0.1
+
+###### _June 30, 2020_
+
+One with delayed fallback and "minimum" loading
+
+- utils: redesign asyncComponentLoader, add delayed fallback and "minimum" loading
+
+## v1.0.0
+
+###### _June 19, 2020_
+
+It's the first stable version of the template. It's going to become a solid foundation for your next React project.
+
+- features: add notifications 🎉
+- readme: update bundle size, fix image titles, add section for notifications, add examples
+
+## v0.1.0
+
+###### _June 19, 2020_
+
+🎉 First release 🎉

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Suren Atoyan
+
+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.