{"_id":"@bas-webapps/bas-style-kit-npm","name":"@bas-webapps/bas-style-kit-npm","dist-tags":{"latest":"0.7.4"},"versions":{"0.7.4":{"name":"@bas-webapps/bas-style-kit-npm","type":"module","version":"0.7.4","description":"The NPM package for the BAS Style Kit","author":{"name":"British Antarctic Survey, webapps@bas.ac.uk"},"scripts":{"clean":"rm -rf dist","copy:images":"cp -r ./images ./dist/images","build:assets":"npm-run-all build:css build:css-min build:js copy:images","build:css":"tailwindcss -i ./css/main.css -o ./dist/css/bas-style-kit.css","build:css-min":"tailwindcss -i ./css/main.css -o ./dist/css/bas-style-kit.min.css --minify","build:js":"node build.js","build:lint":"npx eslint ./","build":"npm run clean && npm run build:lint && npm run build:assets"},"license":"MIT","dependencies":{"@eslint/css":"^1.4.0","@tailwindcss/cli":"^4.1.13","autoprefixer":"^10.4.21","esbuild":"^0.28.1","eslint":"^10.8.0","eslint-plugin-tailwindcss":"^4.0.3","postcss":"^8.5.6","tailwindcss":"^4.1.11","umbrellajs":"^3.3.3"},"gitHead":"ae2616b3e731fe0bc1eb8f4178bd5d3bbf52c22c","_id":"@bas-webapps/bas-style-kit-npm@0.7.4","_nodeVersion":"24.16.0","_npmVersion":"11.13.0","dist":{"integrity":"sha512-7ByP2rH4iCZVji3SgzVIvfuaR8/jcIaHOodF3fC+JZAEU7mFphiHKuEjXJFuifg9t9OY9FGycEB9vyc1M3sJPA==","shasum":"29e21cb364170dc6a1b9ad04bfa4fb3067075f34","tarball":"https://registry.npmjs.org/@bas-webapps/bas-style-kit-npm/-/bas-style-kit-npm-0.7.4.tgz","fileCount":44,"unpackedSize":77972,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIBN9MdntxQQs3YdIG9pB8HsqJexXlx0R2vzawouAs9ZNAiEAjWqQPiQOqK2p4LayNh7Gx5TM64cOLVOAi11fFGztGck="}]},"_npmUser":{"name":"bas-webapps","email":"webapps@bas.ac.uk"},"directories":{},"maintainers":[{"name":"bas-webapps","email":"webapps@bas.ac.uk"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/bas-style-kit-npm_0.7.4_1785161705965_0.02139680180911907"},"_hasShrinkwrap":false}},"time":{"created":"2026-07-27T14:15:05.795Z","0.7.4":"2026-07-27T14:15:06.137Z","modified":"2026-07-27T14:15:06.400Z"},"maintainers":[{"name":"bas-webapps","email":"webapps@bas.ac.uk"}],"description":"The NPM package for the BAS Style Kit","author":{"name":"British Antarctic Survey, webapps@bas.ac.uk"},"license":"MIT","readme":"# BAS Style Kit 2025 - NPM Package\n\nAn NPM package to add the BAS Style Kit to a Node.js project.\n\nThis project lives inside a mono-repo for the BAS Style Kit 2025.\n\nIt is the repo for the CSS & JS source files.\n\nIt builds these files into CSS & JS bundles that can be used for a web UI that is consistent with the look of the BAS public website `www.bas.ac.uk`.\n\nCSS is based on [Tailwind CSS 4]()  \nJS uses [UmbrellaJS]()\n\n## Set up\nThis project requires Node v20 & Node Version Manager v10  \nRecommend that Node Version Manager is used for this\n- [Install NVM](https://www.google.com/url?sa=t&source=web&rct=j&opi=89978449&url=https://github.com/nvm-sh/nvm&ved=2ahUKEwj23NyBo8mPAxXWXEEAHU6tNRQQFnoECBQQAQ&usg=AOvVaw2JVQWl5z3PMGj_flTmT7PU)\n- [NVM Set up guide](https://www.google.com/url?sa=t&source=web&rct=j&opi=89978449&url=https://www.freecodecamp.org/news/node-version-manager-nvm-install-guide/&ved=2ahUKEwj23NyBo8mPAxXWXEEAHU6tNRQQFnoECBMQAQ&usg=AOvVaw1xkwWPXsja-TLQhbPioZc9)\n\n### Install this project\n- Run `npm install`\n\n### Usage\n- Run `npm run build` - a series of files will be created in the `dist` directory\n- See `packages/bas-stylekit-npm/package.json` for more\nSee package.json for more commands  \n\n### Usage in other projects\nThe BAS Style Kit Documentation website uses this package. It is a good example of how to use it:  \n[https://gitlab.data.bas.ac.uk/web-apps/bsk/bas-style-kit-2025-documentation](https://gitlab.data.bas.ac.uk/web-apps/bsk/bas-style-kit-2025-documentation)\n\nThe `package.json` file in the documents project shows how to use NPM commands to help develop and build websites with this NPM package.\n\n#### CSS Styles\nCSS is compiled by Tailwind CSS 4. The main CSS file packages/bas-stylekit-npm/css/main.css imports other files to generate CSS files in the dist directory. The main CSS file also contains the design tokens (values) for the style kit.\n\n#### JS Scripts\nJavaScript is compiled by esbuild via the script here: packages/bas-stylekit-npm/build.js.\nThis script picks up JavaScript files from here: packages/bas-stylekit-npm/js/main.js and generates JavaScript into the dist directory. The scripts here use UmbrellaJS a modern alternative to jQuery.\n\n#### Images & Fonts\nImages and fonts are not directly included in the NPM package. This is so developers can choose how they want assets to be included in their projects. There are two logo images included in this package. The main BAS logo PNG and the favicon ICO.\n\n## Testing\n\n### Integration tests\n\nLinting is used to ensure Sass styles and JavaScript follow a set of standard conventions. They will be executed\nautomatically through *Continuous Integration*:\n\n- [ESlint](https://eslint.org) is used for checking CSS & JavaScript\n\nTo run tests manually run `dev:lint`.  \nSee `package.json` scripts for more.\n\n## Publishing NPM package\nThe contents of the npm package are determined by the `.npmignore` file and `.gitignore` files in this directory and parent directories.\n\nTo create a local packaage\n`npm pack`\n\nLog into a npmjs account - bas-webapps in this instance\n`npm login`\n\nTo publish a new version:\n`npm publish --access public`\n\n## Release procedures\n\nSee the main project for information about how to create new releases:  \n[https://gitlab.data.bas.ac.uk/web-apps/bsk/bas-style-kit-2025/-/tree/main/packages/bas-stylekit-npm](https://gitlab.data.bas.ac.uk/web-apps/bsk/bas-style-kit-2025/-/tree/main/packages/bas-stylekit-npm)\n\n## Issue tracking and contributing\n\nUse the main project issue tracker to raise issues:  \n[https://gitlab.data.bas.ac.uk/web-apps/bsk/bas-style-kit-2025/-/issues](https://gitlab.data.bas.ac.uk/web-apps/bsk/bas-style-kit-2025/-/issues)\n\nSee `CONTRIBUTING.md` for details about how to contribute to this project.\n\n## Feedback\n\nThe maintainer of this project is the BAS Web & Applications Team, they can be contacted through the\n[BAS Service Desk](mailto:servicedesk@bas.ac.uk).\n\n## Licence\nThis project uses the MIT License found here: `LICENSE.md`.\n","readmeFilename":"README.md","_rev":"1-0be3ca9dae660c4ec808de557a0e3ce9"}