Welcome to the Transport for West Midlands Design System.
The TfWM design system is ran at the designated url on startup (usually http://localhost:3000) and is the primary means of viewing your work - it will live update as you make changes.
You'll need Git and Node.js installed to get this project running.
git clone https://github.com/wmcadigital/wmn-design-system.git
npm install
in the root folder.npm start
to launch the dev environment with hot reloading.Having trouble getting these steps to work on your machine? Follow the troubleshooting guide.
For more in-depth information on what each task does, see tasks guide.
Start the TfWM Design System web server.
npm start
Lint the code base for syntax and stylistic errors.
See Linting for more details.
# Lint indentation, Sass, JavaScript files, html
npm run lint:all
# Lint languages independently
npm run lint:styles
npm run lint:templates
npm run lint:scripts
Build the design system for various environments
See Building for more details.
# Build Sass, JavaScript, HTML files
npm run build:all
# Build languages/assets independently
npm run build:styles
npm run build:templates
npm run build:scripts
npm run build:images
npm run build:sprites
npm run build:config
Delete all built languages/assets including temporary build and local files.
npm run clean
See the troubleshooting guide.
See the contributing guide.
Please open a new Github Issue.