FAQ
Table of contents
- Where can I see a change log of what’s changed in Next Right Now?
- How can I subscribe to changes made to Next Right Now, to be notified in the future?
- Can I use NRN on Windows?
- I try to deploy locally, but I get “The specified scope does not exist”
- How is the
i18nextInstance
passed to react? - Should I be keeping the
MST
tenancy design even though I don’t have use for it? - How do I remove plugins/features I do not want?
- What is
MultiversalAppBootstrap
? - What’s the NRN page lifecycle?
- There are a lot of scripts in the
package.json
file, are they documented?
Where can I see a change log of what’s changed in Next Right Now?
We provide a CHANGELOG listing our most important changes. They’re also released in our Community Discussion.
Additionally, as of December 2020, you can see all releases that are automatically created and describe changes, per preset.
How can I subscribe to changes made to Next Right Now, to be notified in the future?
Subscribe to the discussion to be notified when new releases are made, and participate in the discussion about what has changed!
Can I use NRN on Windows?
- On Windows OS, the
yarn start:windows
command should be used instead ofyarn start
- That’s because the
yarn start
command uses some bash script which aren’t compatible with Windows (unless you’re using WSL) - You might want to install WSL on Windows 10 to enable basic bash support
- That’s because the
- NRN v2 has been tested on Windows (on June 1st, 2020) and works correctly
-
Tip: We recommend
nvm-windows
as replacement fornvm
(download thenvm-setup.zip
)
-
Tip: We recommend
- When manually deploying (i.e:
yarn deploy
), the symbolic link forvercel.json
(which points to anothervercel.*.json
file, depending on the preset) will not work on Windows, and you’ll have to create avercel.json
yourself (just copy the content of anyvercel.*.json
file)- This is not a concern if you don’t need to deploy manually from a Windows computer, as CI/CD will deploy properly (CI/CD runs under Unix)
Using Cygwin/Babun
It’s possible to use Cygwin/Babun to simulate a unix-like local environment. It’s not required.
It’s particularly useful if you encounter issues and can’t use wsl2
. (e.g: Not available on < Windows 10)
If you don’t use Cygwin/Babun, check out wsl2
.
- Tip: Babun support has been discontinued in 2019, but it still works perfectly.
-
Tip: Windows 10
wsl2
may provide a better experience - What is wsl2?
I try to deploy locally, but I get “The specified scope does not exist”
$ npx vercel
Vercel CLI 20.1.4
Error! The specified scope does not exist
> More details: https://err.sh/vercel/scope-not-existent
This is because you’re using NRN own scope
in your vercel.*.json
files.
- Remove the whole line
"scope": "team_qnVfSEVc2WwmOE1OYhZr4VST",
in allvercel.*.json
files.-
Tip: Don’t forget
vercel.json
is a symlink and shouldn’t to be modified (runln vercel.staging.json vercel.json
if you messed it up )
-
Tip: Don’t forget
How is the i18nextInstance
passed to react?
Question: I wanted to understand how the i18next integration works. How is the i18nextInstance
passed to react? It seems to be passed to the Layout
component, but the Layout
component never uses it. So how does this work?
- The
i18nextInstance
isn’t necessary to perform translations actually, it’s forwarded as a utility. - Manipulating the
i18nextInstance
is not necessary, usingimport { Trans, useTranslation } from 'react-i18next';
is what you’ll need most of the time when translating content. - The
i18next
library is actually initiated ini18nextLocize.ts
Should I be keeping the MST
tenancy design even though I don’t have use for it?
Question: I don’t find the “plugin” system that highly customizable since “plugins” seem to already be bundled into the 2 main templates you offer, and I have been having hard time trying to rip things out that I don’t need (i18n/locize, example app, MST tenancy (although looks like I can opt out by not using certain vercel json files), and etc.).
See our guide about “How to remove MST”.
How do I remove plugins/features I do not want?
Question: I don’t find the “plugin” system that highly customizable since “plugins” seem to already be bundled into the 2 main templates you offer, and I have been having hard time trying to rip things out that I don’t need (i18n/locize, example app, MST tenancy, etc.).
See our “How to remove X” guides. Each tool has its own “How to remove” section.
If you don’t find what you’re looking for, you can open a discussion/issue on github.
Please contribute to the documentation if you manage to remove something that isn’t properly documented!
What is MultiversalAppBootstrap
?
Question: I would like to understand the purpose of this component MultiversalAppBootstrap.tsx
and its siblings components BrowserPageBootstrap.tsx
, ServerPageBootstrap.tsx
and UniversalGlobalStyles.tsx
, I may have missed something in the documentation. But I don’t understand its usefulness knowing that we have _app
and _document
… are to separate the logic of each type of rendering, or only for maintainability purposes?
See the Application Bootstrap concept.
If you don’t find what you’re looking for, you can open a discussion/issue on github.
What’s the NRN page lifecycle?
See the Application Bootstrap page lifecycle.
There are a lot of scripts in the package.json
file, are they documented?
See the scripts documentation, where all commands are thoroughly explained.