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)

.env.development

@@ -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.development.local" file instead (which isn't tracked by git).
+
+# XXX Tips: When is this file being used?
+# This file is used only during development (localhost).
+# For staging/production stages, the app relies on "now.{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 "now.*.json" files, so that other stages use their own value.
+# Tip: This value must not be changed.
+# Tip: You may override it from ".env.development.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.development.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 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-euwest.graphcms.com/v1/ck73ixhlv09yt01dv2ga1bkbp/master
+
+# GraphQL API key (using GraphCMS vendor), can be found under "Settings > Auth token"
+# 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.development.local" (especially if this is your "master" token)
+GRAPHQL_API_KEY=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImdjbXMtbWFpbi1wcm9kdWN0aW9uIn0.eyJ2ZXJzaW9uIjoyLCJ0b2tlbklkIjoiMGEyZWYwZWYtYmY4Ny00ZmVlLTkzYmQtMzBkMzIzYzAwODM4IiwiaWF0IjoxNTgyNzQ2MDc1LCJpc3MiOiJodHRwczovL21hbmFnZW1lbnQuZ3JhcGhjbXMuY29tLyJ9.wE-IDwFnCNpwUj5AMeGsbf2CGcTgkT1KkE9_l6s-bU03sckdDgV2LXCHH5Fb8XwJGAkoeD5bK9yDnY6oNapiusvg4xRqY-hkRxgh8lB_lTXXpIka6HhjIJz1RQO_dObNGFqr41dKihseBqN5Ce4AJvQBIHyJasKX63xe2eEzdUnWfuNUmrG_XStRu1-xDKKp7vFVox272rr-LqgwRymF3eYcw7J-IAag4qpztoU6zNhKJNYzQKdMMejvMDNg34bHNp4TRIbIUIYpytkwCaAb5TsH98xEiFziU5rUr4EYToSltgE46VnqX2npm56qK-AGp5zauMZgvA20Djtb7BuYqGAqCdOHEQtjjyVLufCu6Y72i9gNQqFQ-WGQ6AFN84KT7BJgRoTruduYG9VhGMOR59HR3jG2QIWXOCt55aI9YwAGNQii0b_QqaoSO08Pb_Ooji5abFLISs70jQb-z1QcnvHIzHnsKqymEWwZhbkxpwf8bv8C6-8k4JGB5YdVj3T_0XQ-OCyvWQIGwVxKysLj8HBeVvXOKUyz7p-thOHbO4qSaRaV7w6_Yy2XtdwBlkIiTTqLezN34vCnsyhZ7N1IgLzp0bwNCyCoPOFs5Q9Ccw7hwJRP3kDT2cW4COJWVt-V5YF_9nnlZN8JjcIgv7FMZKoKRHi004vSosPYGd-v3Uw

.env.development.local.example

@@ -0,0 +1,31 @@
+# XXX Template example
+# This file is an example, meant to be duplicated as ".env.development.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.development".
+
+# XXX Tips: When is this file being used?
+# This file is used only during development (localhost).
+# For staging/production stages, the app relies on "now.{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=

.eslintrc.yml

@@ -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,7 +76,7 @@ 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

.github/workflows/deploy-zeit-production.yml

@@ -13,13 +13,13 @@ jobs:
   # Configures the deployment environment, install dependencies (like node, npm, etc.) that are requirements for the upcoming jobs
   # Ex: Necessary to run `yarn deploy`
   setup-environment:
-    name: Setup deployment environment (Ubuntu 18.04 - Node 10.x)
+    name: Setup deployment environment (Ubuntu 18.04 - Node 12.x)
     runs-on: ubuntu-18.04
     steps:
       - name: Installing node.js
         uses: actions/setup-node@v1 # Used to install node environment - XXX https://github.com/actions/setup-node
         with:
-          node-version: '10.x' # Use the same node.js version as the one Zeit's uses (currently node10.x)
+          node-version: '12.x' # Use the same node.js version as the one Zeit's uses (currently node12.x)
 
   # Starts a Zeit deployment, using the production configuration file of the default institution
   # The default institution is the one defined in the `now.json` file (which is a symlink to the actual file)
@@ -31,7 +31,7 @@ jobs:
     steps:
       - uses: actions/checkout@v1 # Get last commit pushed - XXX See https://github.com/actions/checkout
       - name: Deploying on Zeit
-        run: yarn deploy:$(cat now.json | jq -r '.build.env.CUSTOMER_REF'):production --token $ZEIT_TOKEN
+        run: yarn deploy:$(cat now.json | jq -r '.build.env.NEXT_PUBLIC_CUSTOMER_REF'):production --token $ZEIT_TOKEN
         env:
           ZEIT_TOKEN: ${{ secrets.ZEIT_TOKEN }} # Passing github's secret to the worker
 

.github/workflows/deploy-zeit-staging.yml

@@ -13,13 +13,13 @@ jobs:
   # Configures the deployment environment, install dependencies (like node, npm, etc.) that are requirements for the upcoming jobs
   # Ex: Necessary to run `yarn deploy`
   setup-environment:
-    name: Setup deployment environment (Ubuntu 18.04 - Node 10.x)
+    name: Setup deployment environment (Ubuntu 18.04 - Node 12.x)
     runs-on: ubuntu-18.04
     steps:
       - name: Installing node.js
         uses: actions/setup-node@v1 # Used to install node environment - XXX https://github.com/actions/setup-node
         with:
-          node-version: '10.x' # Use the same node.js version as the one Zeit's uses (currently node10.x)
+          node-version: '12.x' # Use the same node.js version as the one Zeit's uses (currently node12.x)
 
   # Starts a Zeit deployment, using the staging configuration file of the default institution
   # The default institution is the one defined in the `now.json` file (which is a symlink to the actual file)
@@ -36,7 +36,7 @@ jobs:
         #   - Set deployment url to show on PR message
         #   - Create alias and link it
         run: |
-          ZEIT_DEPLOYMENT_OUTPUT=`yarn deploy:$(cat now.json | jq -r '.build.env.CUSTOMER_REF') --token $ZEIT_TOKEN`
+          ZEIT_DEPLOYMENT_OUTPUT=`yarn deploy:$(cat now.json | jq -r '.build.env.NEXT_PUBLIC_CUSTOMER_REF') --token $ZEIT_TOKEN`
 
           ZEIT_DEPLOYMENT_URL=`echo $ZEIT_DEPLOYMENT_OUTPUT | egrep -o 'https?://[^ ]+.now.sh'`
           echo "::set-env name=ZEIT_DEPLOYMENT_URL::$ZEIT_DEPLOYMENT_URL"
@@ -46,13 +46,19 @@ jobs:
           else
             ZEIT_DEPLOYMENT_ALIAS=$(cat now.json | jq -r '.name')-${CURRENT_BRANCH##*/}
           fi
-
-          # Zeit alias only allows 53 characters in the domain name, so we only keep the first 46 characters (because Zeit needs 7 chars for ".now.sh" at the end of the domain name)
-          # Also, in order to remove forbidden characters, we create a sequence from ascii numbers using ranges of numbers (we forbid characters by using `seq X Y` and we add others by using ';'). 
-          # All special characters are converted to `-` (using `tr $0 $1` where $0 is replaced by $1), and only 0-9 and a-Z chars are kept intact. 
-          # We then use `awk` to convert "ascii numbers" back into actual characters.
-          # You can find the numbers equivalence by tapping `man ascii` and look at the "decimal" set. 
-          ZEIT_DEPLOYMENT_ALIAS=$(echo $ZEIT_DEPLOYMENT_ALIAS | head -c 46 | tr "`(seq 0 47 ; seq 58 64 ; seq 91 96 && seq 123 127) | awk '{printf("%c",$1)}'`" -).now.sh
+
+          # Zeit alias only allows 53 characters in the domain name, so we only keep the first 45 (45 = 53 - 7 - 1) characters (because Zeit needs 7 chars for ".now.sh" at the end of the domain name, and count starts at 1, not 0)
+          # Also, in order to remove forbidden characters, we transform every characters which are not a "alnum" and \n or \r into '-'
+
+          ZEIT_DEPLOYMENT_ALIAS=$(echo $ZEIT_DEPLOYMENT_ALIAS | head -c 45 | tr -c '[:alnum:]\r\n' - | tr '[:upper:]' '[:lower:]')
+
+          # Recursively remove any trailing dash ('-')
+          while [[ "$ZEIT_DEPLOYMENT_ALIAS" == *- ]]
+          do
+                  ZEIT_DEPLOYMENT_ALIAS=${ZEIT_DEPLOYMENT_ALIAS::-1}
+          done
+
+          ZEIT_DEPLOYMENT_ALIAS=$ZEIT_DEPLOYMENT_ALIAS.now.sh
           echo "::set-env name=ZEIT_DEPLOYMENT_ALIAS::https://$ZEIT_DEPLOYMENT_ALIAS"
 
           npx now alias $ZEIT_DEPLOYMENT_URL https://$ZEIT_DEPLOYMENT_ALIAS --token $ZEIT_TOKEN

.gitignore

@@ -69,6 +69,7 @@ fabric.properties
 *.iml
 modules.xml
 .idea/misc.xml
+.idea/codeStyles
 *.ipr
 vcs.xml
 
@@ -118,9 +119,10 @@ coverage/
 /.next/
 /out/
 
-# misc
-.env*
-!.env.build.example
+# Next.js environment variables - See https://nextjs.org/docs/basic-features/environment-variables#exposing-environment-variables
+.env.build
+.env*.local
+!.env*.example
 
 # debug
 npm-debug.log*

.nowignore

@@ -12,3 +12,7 @@ README.md
 schema.graphql
 yarn.lock
 yarn-error.log
+
+# Avoid tests being deployed as Vercel Serverless Functions (increases bundle size, and count towards limits)
+src/pages/api/*.test.ts
+src/pages/api/**/*.test.ts

cypress/config-customer1.json

@@ -1,5 +1,5 @@
 {
-  "baseUrl": "https://nrn-v1-ssr-mst-aptd-gcms-lcz-sty-c1.now.sh/",
+  "baseUrl": "https://nrn-v2-mst-aptd-gcms-lcz-sty-c1.now.sh/",
   "projectId": "4dvdog",
   "screenshotsFolder": "cypress/screenshots/customer1",
   "videosFolder": "cypress/videos/customer1",

cypress/config-customer2.json

@@ -1,5 +1,5 @@
 {
-  "baseUrl": "https://nrn-v1-ssr-mst-aptd-gcms-lcz-sty-c2.now.sh/",
+  "baseUrl": "https://nrn-v2-mst-aptd-gcms-lcz-sty-c2.now.sh/",
   "projectId": "4dvdog",
   "screenshotsFolder": "cypress/screenshots/customer2",
   "videosFolder": "cypress/videos/customer2",

cypress/integration/app/pages/index.js

@@ -23,14 +23,17 @@ describe('Index page', () => {
    * Navbar section
    */
   it('should have 5 links in the navigation bar', () => {
-    cy.get('#nav a.nav-link').should('have.length', 5);
+    cy.get('#nav .navbar-nav > .nav-item').should('have.length', 5);
   });
 
   it('should have a link in the navbar that redirects to the examples page', () => {
-    cy.url().should('eq', `${baseUrl}/`);
+    cy.url().should('eq', `${baseUrl}/en`);
     cy.get('#nav-link-examples')
       .should('have.text', 'Examples')
       .click();
-    cy.url().should('eq', `${baseUrl}/examples`);
+    cy.get('#nav-link-examples-static-i-18-n')
+      .should('have.text', 'Static i18n')
+      .click();
+    cy.url().should('eq', `${baseUrl}/en/examples/built-in-features/static-i18n`);
   });
 });

docs/.gitignore

@@ -0,0 +1,3 @@
+_site
+.sass-cache
+.jekyll-metadata

docs/404.html

@@ -0,0 +1,25 @@
+---
+layout: default
+nav_exclude: true
+---
+
+<style type="text/css" media="screen">
+  .container {
+    margin: 10px auto;
+    max-width: 600px;
+    text-align: center;
+  }
+  h1 {
+    margin: 30px 0;
+    font-size: 4em;
+    line-height: 1;
+    letter-spacing: -1px;
+  }
+</style>
+
+<div class="container">
+  <h1>404</h1>
+
+  <p><strong>Page not found :(</strong></p>
+  <p>The requested page could not be found.</p>
+</div>

docs/Gemfile

@@ -0,0 +1,27 @@
+# XXX This file is only used when working on your local machine, in development
+# Run `yarn doc:start` to start the development server
+# Read ./CONTRIBUTING.md for further instructions
+
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# If you have any plugins, put them here!
+group :jekyll_plugins do
+  gem 'just-the-docs' # XXX Our Jekyll theme - See https://pmarsceill.github.io/just-the-docs/
+  gem "github-pages" # XXX Necessary to reproduce the behaviour of GitHub Pages - When this is loaded, "jekyll" must not be bundled because it's included within
+  gem 'jemoji' # XXX GitHub-flavored Emoji plugin for Jekyll - See https://github.com/jekyll/jemoji
+end
+
+# ------- WINDOWS SUPPORT ---------
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+# and associated library.
+install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do
+  gem "tzinfo", "~> 1.2"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1.0", :install_if => Gem.win_platform?
+