ccs-frontend-kit
v1.1.4
Published
css kit for ccs projects
Downloads
19
Readme
CCS-Frontend-Kit
Npm package that contains all the styles and assets of the CCS website. This is so that any new projects can import the same css and keep the styles consistent across all applications in CCS.
Create a new project
$ mkdir [name of your project]
$ cd [name of your project]
$ npm init
$ npm install sass
Install Frontend Kit inside your project
$ npm install ccs-frontend-kit
check `node_modules` to find ccs-frontend-kit package
Copy fonts, images and scripts from Frontend Kit to your project
At the root of your project:
$ mkdir Assets
Copy fonts, images and scripts into your Assets folder:
$ cp -R ./node_modules/ccs-frontend-kit/Assets/fonts ./Assets/fonts
$ cp -R ./node_modules/ccs-frontend-kit/Assets/images ./Assets/images
$ cp -R ./node_modules/ccs-frontend-kit/Assets/scripts ./Assets/scripts
(You can also add a script for this copy to package.json)
Copy the govuk package
$ cp -R ./node_modules/govuk-frontend/govuk ./Assets/scripts/govuk
Link the styles from ccs-frontend-kit to your project
$ cd Assets && mkdir styles
$ cd styles
$ touch main.scss
Add the following line inside main.scss:
@import "../../node_modules/ccs-frontend-kit/Assets/styles/styles.scss";
If needed, modify this path so that it correctly points to the imported file.
Compile scss into css:
Add the following script to package.json:
"compile": "cd ./Assets/styles && sass main.scss main.css"
$ npm run compile
If there are errors during this compile
edit the import for govuk-frontend/govuk/all
from inside the ./node_modules/ccs-frontend-kit/Assets/styles/styles.scss
,
so that it points to the file correctly.
Import the styles to your main html file
At the root of your project
$ touch index.html
Inside the <head>
tag, add a link tag pointing to your compiled main.css:
<link rel="stylesheet" href="./Assets/styles/main.css">
Add these scripts at the bottom of the <body>
tag:
<body>
...
<script src="./Assets/scripts/libraries/jquery-1.12.4.js"></script>
<script src="./Assets/scripts/libraries/objectFitPolyfill.js"></script>
<script src="./Assets/scripts/app.js"></script>
<script src="./Assets/scripts/govuk/all.js"></script>
</body>
Find and test a component by copying its markdown from https://gov.uk website.