README
vaadin-themes
vaadin-themes is a set of customizable themes for the Vaadin Core Elements.
Nothing to show yet
Contributing
Fork the
vaadin-themes
repository and clone it locally.Make sure you have npm installed.
When in the
vaadin-themes
directory, runnpm install
to install dependencies.
Running demos and tests in browser
Install polyserve:
npm install -g polyserve
When in the
vaadin-themes
directory, runpolyserve --open
, browser will automatically open the component API documentation.You can also open demo or in-browser tests by adding demo to the URL, for example:
Following the coding style
We are using ESLint for linting JavaScript code. You can check if your code is following our standards by running gulp lint
, which will automatically lint all .js
files as well as JavaScript snippets inside .html
files.
Creating a pull request
- Make sure your code is compliant with our code linters:
gulp lint
- Check that tests are passing:
npm test
- Submit a pull request with detailed title and description
- Wait for response from one of Vaadin Elements team members
License
Apache License 2.0