2. Installation & setup - JayBox325/JayPack GitHub Wiki
Node Version Manager
To keep your projects self-contained, this project has an .nvmrc file in the root of the project. If you haven't used Node Version Manager before, install it here: https://github.com/nvm-sh/nvm. To use a configured Node version, run nvm use
after downloading JayPack, but before installing your npm packages below.
Global requirements
This project uses Gulp and TypeScript, so I have those installed globally and not at a project-level. Install these with npm i -g typescript
and npm i -g gulp
Installation
To install JayPack's dependencies, run npm i
from your root directory. This will download and install everything it needs inside a node_modules
directory.
Setup
The first file to open once you have installed everything is ./project-config
. Here you decide if you want to use static HTML generated from Nunjucks files, or if you will be using a CMS.
If you are not using JayCraft, you have some extra steps to make.
At the time of writing the craft
option isn't necessarily tied to CraftCMS. But it's more of a 'CMS' option so your assets are compiled and saved in the appropriate destination.
The domain
option is so browsersync can refresh your localhost URL when it detects changes.