Home Skillet

Front End Build Toolkit

Getting Started

Install Dependencies

npm i

This will install all required dependencies and devDependencies defined in package.json.

DEV

After NPM installs all required dependencies, navigate to node_modules/name-that-color/index.js and modify the module as follows:

if (require.main === module)
{
    console.log(chalk.magenta(process.argv[2]) + ' name is ' + chalk.cyan(ntc.name(oneColor(process.argv[2]).hex())[1]));
}
else
{
    module.exports = ntc;
}

Next, create an .env file using .env.example as, well, an example lol.

Then execute the following command:

npm start

This will compile the project into _dev, launch your browser and watch for changes in _src.

Modes

The toolkit has options to launch in different modes:

HMR Mode - Hot Module Replacement

npm run hmr

Ignored when running a build.

Tooling Mode

npm run tooling

While you can run HMR and Tooling modes together, HMR is only for _src development.

Fun Mode :)

npm run fun

Conf Mode Shush!

npm run conf

Build

To run a production build, execute the following command:

npm run build

This will compile and minify the project into _build.

Source code

All source code is located in _src.

• Core JavaScript/Typescript => _src/js
• Core SASS => _src/sass
• Modules (Javascript/Typescript, SCSS and HTML) => _src/modules