One place for service teams to find styles, components and patterns for designing government services.

Run locally

You'll need Git and Node.js installed to get this project running.

Note: You will need the active LTS (Long-term support) Node.js version for this project (as specified in .nvmrc)

Fork repository (optional)

If you're an external contributor make sure to fork this project first

Clone repository

git clone git@github.com:Ceylon-Design/Ceylon.design.git # or clone your own fork

cd Ceylon-Design-Ceylon.design

Using nvm (optional)

If you work across multiple Node.js projects there's a good chance they require different Node.js and npm versions.

To enable this we use nvm (Node Version Manager) to switch between versions easily.

1. install nvm
2. Run nvm install in the project directory (this will use .nvmrc)

Install npm dependencies

Start a local server

This will build sources, serve pages and watch for changes.

Build

Build ./src to ./deploy/public

Run the Sass linter

We are using the sass-lint plugin to lint the Sass files in source/stylesheets. You can run the linter from command line by running:

Ceylon.design Frontend packages

Design System consumes the Ceylon.Design Frontend package via NPM. This is defined in the package.json file.