V2 - New preset v2-mst-aptd-gcms-lcz-sty with hybrid SSG/SSR instead of SSR-only (based on v1-ssr-mst-aptd-gcms-lcz-sty)

.codeclimate.yml

@@ -16,15 +16,15 @@ checks:
   method-complexity:
     enabled: true
     config:
-      threshold: 10
+      threshold: 25 # 10 by default
   method-count:
     enabled: true
     config:
       threshold: 20
   method-lines:
     enabled: true
     config:
-      threshold: 100 # 25 by default
+      threshold: 300 # 25 by default
   nested-control-flow:
     enabled: true
     config:
@@ -62,7 +62,9 @@ plugins:
 exclude_patterns:
   - "**/*.test.*"
   - "**/*.spec.*"
-  - "src/svg/"
+  - "svg-to-react/"
+  - "cypress/"
+  - "src/modules/core/testing/mocks"
 
   # Default CC excluded paths:
   - "config/"

.env

@@ -0,0 +1,55 @@
+# See https://nextjs.org/docs/basic-features/environment-variables
+
+# XXX Tips: How is this file meant to be used?
+# This file is tracked by git and must only contains NON-SENSITIVE information, which is usually meant to be available in the browser.
+# Sensitive information (server-side only) MUST be written in ".env.local" file instead (which isn't tracked by git).
+
+# XXX Tips: When is this file being used?
+# This file is used only when building the Next.js app locally (localhost), whether it's for running `next dev` or `next build`.
+# For staging/production stages, the app relies on "vercel.{NEXT_PUBLIC_CUSTOMER_REF}.{NEXT_PUBLIC_APP_STAGE}.yml:build.env".
+
+# XXX Tips: What's the difference between env vars starting with "NEXT_PUBLIC_" and the others?
+# All env variables that DON'T start with "NEXT_PUBLIC_" MUST be manually exposed by ./next.config.js for the project to work locally
+# "NEXT_PUBLIC_" has a semantic purpose. If you mean to use a variable on the browser, then you should use "NEXT_PUBLIC_".
+# Any non-sensitive env variable should start with "NEXT_PUBLIC_".
+# Sensitive information MUST NOT start with "NEXT_PUBLIC_".
+# You must be careful to use sensitive information only on the server-side, because if you use them on the browser or getInitialProps, they'll be leaked, even if the variable doesn't start with "NEXT_PUBLIC_".
+# Any change to this file needs a server restart to be applied.
+
+# The stage is "how" the application is running.
+# It can be either "development", "staging" or "production".
+# This value is also set in each "vercel.*.json" files, so that other stages use their own value.
+# Tip: This value must not be changed.
+# Tip: You may override it from ".env.local" if you want to simulate another stage, locally.
+NEXT_PUBLIC_APP_STAGE=development
+
+# The name of the NRN preset being used.
+# Used by the demo to redirect to the preset branch/documentation.
+NEXT_PUBLIC_NRN_PRESET=v2-mst-aptd-gcms-lcz-sty
+
+# The customer that is being used.
+# Tip: You may override it from ".env.local" if you want to simulate another customer, locally.
+NEXT_PUBLIC_CUSTOMER_REF=customer1
+
+# Locize project ID, can be found in the project "settings" page
+# Used to fetch the i18n translations
+# Tip: The value being used below is valid, so that you can run the demo locally without having to create your own Locize account, but you cannot make any change
+NEXT_PUBLIC_LOCIZE_PROJECT_ID=658fc999-dfa8-4307-b9d7-b4870ad5b968
+
+# Amplitude API key, can be found under "Manage Data > Project name > Project settings > API Key"
+# Used to send analytics usage
+# Tip: The value being used below is valid, so that you can run the demo locally without having to create your own Amplitude account, but you cannot access the data
+NEXT_PUBLIC_AMPLITUDE_API_KEY=5ea02d86a6840c165fcc01377131fa13
+
+# GraphQL v2 API endpoint (using GraphCMS vendor)
+# Used to fetch content from GraphCMS
+# Tip: The value being used below is valid, so that you can run the demo locally without having to create your own GraphCMS account
+# XXX We only use one stage ("master") due to the free plan's limitation, but using two stages is more secure for enterprise-grade apps
+GRAPHQL_API_ENDPOINT=https://api-eu-central-1.graphcms.com/v2/ck73ixhlv09yt01dv2ga1bkbp/master
+
+# GraphQL API key (using GraphCMS vendor), can be found under "Settings > API Access > Permanent Auth Tokens"
+# Used to fetch content from GraphCMS, this token only has read-only permissions to avoid data tempering (especially since we made it public within NRN)
+# This variable is only used server-side
+# Tip: The value being used below is valid, so that you can run the demo locally without having to create your own GraphCMS account
+# XXX For the purpose of this demo, we're tracking this in git, but unless you're building an open API you'll want to move it to ".env.local" (especially if this is your "master" token)
+GRAPHQL_API_KEY=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImdjbXMtbWFpbi1wcm9kdWN0aW9uIn0.eyJ2ZXJzaW9uIjozLCJpYXQiOjE2MDYyMTEyNDgsImF1ZCI6WyJodHRwczovL2FwaS1ldS1jZW50cmFsLTEuZ3JhcGhjbXMuY29tL3YyL2NrNzNpeGhsdjA5eXQwMWR2MmdhMWJrYnAvbWFzdGVyIl0sImlzcyI6Imh0dHBzOi8vbWFuYWdlbWVudC5ncmFwaGNtcy5jb20vIiwic3ViIjoiMzRiNGMxZDgtNWY1Mi00MWM3LWJjNDYtMDM5MzM1NDc0OTVlIiwianRpIjoiY2todnNwZjA4bXg0aDAxdzliMmN6YXVwZCJ9.TfJDn4V9gGK5n7sI8limca4DnFjxREgsPDV5lf5yhA74BSwHq8XH-nU6cP18qf-IQ_wN7Ujw4MRY4LcazylR0IBli4dzrtKHZ0pEvZilZ0AfJ-80LBJQCVLNEiSuFKnIDUHe58MqMUZT8UoYFaWMH_cl7a3SOmdRCwsm93U5JYkjt7mqoH5Y-WaC3yl4Cq9IYexjHCJZLiFRZh8CL0jV6ddu8ghScegYTo_nJsZxHow12tuKI0I_3cJhdpcRL3HsTZWTQV8PPL0bhbLE1F7y0GksquKuSRScrTMBewYCgDWkxt7EcjRSuUR9WixQPVcTjHpnm_c3lL0HqUsDc_5aJV0POJUa9_T8m4_uFstZtBMtfmg6yBGOB8f06f27JyrCA5NZLNXMScmG06DbGOM8gbquN4-XigTj4t3jwSrzCRZ1zuFZEMoBruH0ElOqJ9hq05_WnGSpyD4NQl9l0bV1TXz5WMzoThlShrpL3f0A74ojXdel8awq9uTPB8qX7AAQa5m7n7lEmsD0tfom4ijiJeFdJakyNpoxY8TXPAgO819MPxE_z3qEynxu3QLS3jW2hc0mteLO0pNkl_twPGIwn7eBlv4u6S31pLXOT5aAIIMqsa1eoi8XwGKFLGhjZzDN_AsF-aBudoK8uhmNYCA7DyqWMXi2rvGyuYNU9Wu3XAs

.env.local.example

@@ -0,0 +1,40 @@
+# XXX Template example
+# This file is an example, meant to be duplicated as ".env.local" for local override
+
+# See https://nextjs.org/docs/basic-features/environment-variables
+
+# XXX Tips: How is this file meant to be used?
+# This file is NOT tracked by git and can contain sensitive information, or override variables from ".env".
+
+# XXX Tips: When is this file being used?
+# This file is used only when building the Next.js app locally (localhost), whether it's for running `next dev` or `next build`.
+# For staging/production stages, the app relies on "vercel.{NEXT_PUBLIC_CUSTOMER_REF}.{NEXT_PUBLIC_APP_STAGE}.yml:build.env".
+
+# XXX Tips: What's the difference between env vars starting with "NEXT_PUBLIC_" and the others?
+# All env variables that DON'T start with "NEXT_PUBLIC_" MUST be manually exposed by ./next.config.js for the project to work locally
+# "NEXT_PUBLIC_" has a semantic purpose. If you mean to use a variable on the browser, then you should use "NEXT_PUBLIC_".
+# Any non-sensitive env variable should start with "NEXT_PUBLIC_".
+# Sensitive information MUST NOT start with "NEXT_PUBLIC_".
+# You must be careful to use sensitive information only on the server-side, because if you use them on the browser or getInitialProps, they'll be leaked, even if the variable doesn't start with "NEXT_PUBLIC_".
+# Any change to this file needs a server restart to be applied.
+
+# Locize API key, can be found under "Your project > Settings > Api Keys" at https://www.locize.app/?ref=unly-nrn
+# Used to automatically save missing translations when working locally
+# Optional - If not set, the app will work anyway, it just won't create new keys automatically
+# Example (fake value): 615384ff-0f39-4c7b-89ca-9b0acbfd0869
+LOCIZE_API_KEY=
+
+# Sentry DSN, can be found under "Your project > Client Keys (DSN)" at https://sentry.io/settings/YOUR_ORG/projects/YOUR_PROJECT/keys/
+# Used to send monitoring events (errors, etc.)
+# Optional - If not set, the app will work anyway, it just won't send any event
+# Example (fake value): https://[email protected]/1234567
+SENTRY_DSN=
+
+# Github "personal access token", can be generated at "Settings > Developer settings > Personal access tokens" at https://github.com/settings/tokens
+# Used by "Workflow Dispatch" GitHub Actions
+# Needs the following scopes:
+#  - Repo (FULL)
+#  - Workflow
+# Optional - If not set, the app will work anyway, it just won't be able to deploy new instances through the "startVercelDeployment" API
+# Example (fake value): 278c560c1314b8b032c1314b856072bdaaaaaaaa
+GITHUB_DISPATCH_TOKEN=

.eslintignore

@@ -1,8 +1,10 @@
 node_modules
 .next
+cypress
 src/**/*.test*
 src/gql/**
 src/propTypes/**
 src/svg/**
 src/types/**
 src/components/svg/**
+src/stories/sb-examples/**

.eslintrc.yml

@@ -6,15 +6,15 @@ env:
   node: true
 extends:
   - plugin:@typescript-eslint/recommended
-  - plugin:react/recommended
   - plugin:jsx-a11y/recommended
+  - next # Recommended to be added last after all other "recommended" tools - See https://nextjs.org/docs/basic-features/eslint#disabling-rules
+  - next/core-web-vitals # Enforce stronger rules for Core Web Vitals - See https://nextjs.org/docs/basic-features/eslint#core-web-vitals
 globals:
   Atomics: readonly
   SharedArrayBuffer: readonly
 plugins:
   - jest
-  - react
-  - react-hooks
+  - '@emotion'
 parser: '@typescript-eslint/parser'
 parserOptions:
   project: ./tsconfig.json
@@ -44,9 +44,7 @@ rules: # See https://eslint.org/docs/rules
   strict: 'off'
   no-console: 1 # Shouldn't use "console", but "logger" instead
   allowArrowFunctions: 0
-  no-unused-vars:
-    - warn # Warn otherwise it false-positive with needed React imports
-    - args: none # Allow to declare unused variables in function arguments, meant to be used later
+  no-unused-vars: 0 # Disabled, already handled by @typescript-eslint/no-unused-vars
   import/prefer-default-export: 0 # When there is only a single export from a module, don't enforce a default export, but rather let developer choose what's best
   no-else-return: 0 # Don't enforce, let developer choose. Sometimes we like to specifically use "return" for the sake of comprehensibility and avoid ambiguity
   no-underscore-dangle: 0 # Allow _ before/after variables and functions, convention for something meant to be "private"
@@ -78,19 +76,32 @@ rules: # See https://eslint.org/docs/rules
   react-hooks/exhaustive-deps: warn
   react/jsx-no-target-blank: warn # Not using "noreferrer" is not a security risk, but "noopener" should always be used indeed
   react/prop-types: warn # Should be handled with TS instead
-  react/no-unescaped-entities: warn # Causes text mismatch when enabled
+  react/no-unescaped-entities: 0 # Causes text mismatch when enabled
   jsx-a11y/anchor-is-valid: warn
   linebreak-style:
     - error
     - unix
-  '@typescript-eslint/ban-ts-ignore': warn # ts-ignore are sometimes the only way to bypass a TS issue, we trust we will use them for good and not abuse them
+  '@typescript-eslint/ban-ts-comment': warn # ts-ignore are sometimes the only way to bypass a TS issue, we trust we will use them for good and not abuse them
   '@typescript-eslint/no-use-before-define': warn
   '@typescript-eslint/no-unused-vars':
     - warn
     -
       vars: 'all' # We don't want unused variables (noise) - XXX Note that this will be a duplicate of "no-unused-vars" rule
       args: 'none' # Sometimes it's useful to have unused arguments for later use, such as describing what args are available (DX)
       ignoreRestSiblings: true # Sometimes it's useful to have unused props for later use, such as describing what props are available (DX)
+      varsIgnorePattern: 'React|logger|rest'
+  '@typescript-eslint/ban-types':
+    - error
+    -
+      extendDefaults: true
+      types:
+        '{}': false # Allow writing `type Props = {}` - See https://github.com/typescript-eslint/typescript-eslint/issues/2063#issuecomment-632833366
+  '@typescript-eslint/no-explicit-any': off
+
+  # Emotion rules - See https://github.com/emotion-js/emotion/tree/master/packages/eslint-plugin
+  # Emotion 11 - See https://emotion.sh/docs/emotion-11
+  '@emotion/pkg-renaming': error
+
 overrides:
   - files: ['**/*.tsx']
     rules:

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+
+**Smartphone (please complete the following information):**
+ - OS: [e.g. iOS8.1]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/having-a-question-.md

@@ -0,0 +1,10 @@
+---
+name: Having a question?
+about: Use the community Discussions
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Please ask questions in the [Discussions](https://github.com/UnlyEd/next-right-now/discussions)! :)

.github/workflows/README.md

@@ -0,0 +1 @@
+Learn more about [our CI/CD configuration](https://unlyed.github.io/next-right-now/guides/ci-cd/)