Skip to content

Latest commit

 

History

History
64 lines (48 loc) · 3.36 KB

README.md

File metadata and controls

64 lines (48 loc) · 3.36 KB

First-time setup instructions:

YOURNAMEHERE Design System

Setup

  1. Before running the project setup node/npm (Installation instructions).

  2. Run npm install.

  3. Run npm start. This will:

  • Clear any previously built project files
  • Build project files
  • Start the server (localhost:3000)
  • Run watch tasks

Drizzle

The pattern library is powered by Drizzle and will be organized by:

Public

The contents of the public/ directory will be copied directly into the root of the dist/ directory.

Sass

All CSS is compiled from Sass and can be found in the scss/ directory. Any files not prefixed with an underscore will compile to dist/css/.

JavaScript

All JavaScript is compiled with Webpack and can be found in the js/ directory. All JavaScript files should be imported into index.js which will then be compiled to dist/js/scripts.js.

Testing

Running npm test will run the following tasks: