README.md

Omegaweb Design

Design guidelines and component libraries for the Omegaweb

Getting Started

Prerequisites

You'll need Node.js + npm, a good code editor (VSCode or Atom) and a nice browser (Google Chrome or Mozilla Firefox).

Developing

Start the local development server with

$ npm run dev

This will also open the demo page in your browser. The webpage will update automatically as you make changes to the source code.

The source for the actual design system is located in src while the demo that is shown in your browser (just a Vue app that uses the design system) is located in demo.

Testing

To run the tests on your changes, use

$ npm test

This will perform static tests of the source code for both design system and demo (check for coding style errors).

To automatically fix coding style errors, use

$ npm run styling

License

This project is licensed under the MIT license - see LICENSE file for details.