The package.json file lives in your site_repo/development folder. This is the file that will be referenced when installing the dependencies for your site so that you can run gulp and grunt tasks.
When making changes to your package.json, make sure to always run npm install again after your changes are complete to ensure that everything goes through as expected.
- site - Financial Institution name in double quotes. This will be injected into various places throughout the site, like the title tag, copyright line in the footer, and logo alt. Make sure to write the name as provided–for example, if the Trello card says “First Bank and Trust Company”, write that as shown, and do not shorten to “1st Bank & Trust Co.” or something like that.
- zip - the name of the zip file that will be found in the site_repo/development/deploy folder. This should be the domain name so for banno.com the zip would be banno
- baseFont, altFont, optionalFont - Up to three fonts that are used for the project. Include it as the font name with any weights or italic versions, in double quotes–for example,
"basefont":"Source Sans Pro:100,100i,200". - gaCode - The Google Analytics code for the site. This is a value that will start with “UA-” or “G-” and should be provided by the project coordinator on the trello card for the site. This value will be injected into the ga.mustache file. If it’s not provided to you initially, you can leave this blank, but if the value is added later on make sure to run npm install again.
- microsite - This can take two values, “basic” or “custom”. “basic” provides you with files for a fairly plain / unstyled microsite, while “custom” provides you with files for a more styled version. This isn’t necessarily something that the client is paying for, so leaving it as “basic” is usually fine - these automatically generated files will be copied into your microsite folder once you create it, and can of course be edited there as needed.
- monitor - Boolean. Indicates whether or not the FI purchased Banno Monitor (previously known as Sentinel). If it’s set to true, the mustache file for templates > partials > banno-components > banno-monitor will be un-commented within your footer.mustache. If left false, it will stay hidden. Note that the make.json file does not automatically update based on the package.json, so if your site has Banno Monitor, you will need to go into the make.json file and manually add “SENTINEL” to the list of features if it’s not already there, and manually set “showSentinel”:true as a value on all pages.
- smartbanner - Boolean. Indicates whether or not the client has smart banners for their mobile app. If they do, this should be noted on the trello card for the site, and two URLs should be provided by the PC. If set to true, this will allow the templates > partials > smartbanner mustache file to be pulled in within top.mustache. If this is set to true, but URLs are not provided in the two below lines, you will get a console error until the URLs are added.
- smartbannerApple - If the client has smartbanners, you can put their Apple Store URL here in double quotes. This value is then injected into the smartbanner.mustache file.
- smartbannerGoogle - If the client has smartbanners, you can put their Google Play Store URL here in double quotes. This value is then injected into the smartbanner.mustache file.
- dqmPremium - Boolean. This indicates whether or not the client purchased DQM Premium with their site. If set to true, this will allow the DQM Premium sticky banner to show on the site, uncommenting the necessary script, styles, and mustache files. Note that the make.json file does not automatically update based on the package.json, so if your site has DQM Premium, you will need to go into the make.json file and manually add the Accessibility Feedback form and page, if it doesn’t already exist.
- bankLocation - The main branch city and state, in double quotes (for example
"bankLocation": "Cedar Falls, IA"). This value will be injected into the alt tag of the logo within header.mustache. - domain - Live site domain of the website, for example
"domain":"https://www.banno.com". - scaffold - The make.json file. This line needs to match the make file name or scaffolding the site will not work.
- url - tells grunt task where to push changes to. Update to match your site. Contains two sub-values:
- uat - Includes the UAT URL of your site. The DNS for the UAT site should have already been set up by the PC and included on the trello card. For example,
"uat":"firstbank-uat.banno.com". - prod - The live URL of the site. Note the lack of protocol/www. For example, all you need to enter is
"prod":"firstbank.com".
- uat - Includes the UAT URL of your site. The DNS for the UAT site should have already been set up by the PC and included on the trello card. For example,
- environment - Tells the script what to look for when pushing. You will not need to edit either of these values.
- name - The name of the FI, hyphenated, and in all lowercase. For example,
"name":"first-bank-and-trust-company". - version - You won’t need to edit this value.
- description - A very brief description of the value. Something like the name of the FI followed by “website” is enough, for example:
"description":"First Bank and Trust Company Website" - browserslist - tells autoprefixer which browsers to support so it can include necessary vendor prefixes. You won’t normally need to edit these values.
- devDependencies - Dependencies that the site needs to run Grunt and/or Gulp tasks. You won’t normally need to edit these values.
- repository - git repo url for the site. This is just extra info on a project and does NOT tell the repo where to push to that is in the .git folder that is in the same directory as the development folder. Contains two sub-values:
- type - The type of repository that it is.
- url - Should be updated to contain the SSH URL for the repo.
- bootstrap-version - Lets support devs know which version of Bootstrap to expect. Usually written as “Bootstrap” followed by a number, within double quotes. We have sites on each version of Bootstrap back to Bootstrap 2.
- author - Your name. Make sure that it is written properly with the first letter capitalized, and spelled correctly. This value is used to find your unique user ID and allow you to upload to UAT from iTerm. For example,
"author": "Jean-Luc Picard". - original-dev - The original developer of the site. Not used for any upload credentials, but is useful to know if you want to ask the original developer any questions about their build.
- license - You won’t need to edit this value.