Guidance for installing the nidirect-frontend node package manager (npm) package
- For more information on npm, read the node.js article, What is npm?
Before you install the nidirect-frontend package
You will need to:
- Install node.js
- Install govuk-frontend npm package version 5.0.0 or above.
For guidance on how to do this, visit the GOV.UK frontend website. - Install a SASS compiler to generate the CSS code for both packages.
Most popular integrated development environments (IDE) support plugins or extensions that allow you to compile SASS easily. Or if you prefer, you can compile the SASS manually using the command line.
Installing the nidirect-frontend package
-
Open a command line window
-
Navigate to root folder of your application using the change directory command
cd
followed by the path to the root folder of your application.For example:
cd user/documents/myapplication
-
Within your application's root folder, install the npm package using the command:
npm i nidirect-frontend
-
When the installation finishes, the nidirect-frontend package will be in the same folder that govuk-frontend package is held.
Implementing the code in your project
- Check that both the govuk-frontend and nidirect-frontend packages are in your project folder
- Use a SASS compiler with the file
nidirect-all.scss
to generate the CSS code for both packages.