diff options
| author | Artur <artur@vaadin.com> | 2018-05-02 16:15:59 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-02 16:15:59 +0300 |
| commit | e6ac37f948c86e8765b8ae171c8c78fa9eaa3c97 (patch) | |
| tree | e03639bed5d04c09b9e66624ac7f120a9be0d10e | |
| parent | 5d051efb35ecb9f6db2575d87e940e689fc6f120 (diff) | |
| download | vaadin-e6ac37f948c86e8765b8ae171c8c78fa9eaa3c97.tar.gz vaadin-e6ac37f948c86e8765b8ae171c8c78fa9eaa3c97.zip | |
Update README.md (#25)
| -rw-r--r-- | DEVELOPMENT.md | 82 | ||||
| -rw-r--r-- | README.md | 76 |
2 files changed, 153 insertions, 5 deletions
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..9f0f284 --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,82 @@ +## Developing Vaadin components + +Each Vaadin component has it's own GitHub repository, where development is done. The vaadin-core project is just a top-level bundle without actual production code. + +Familiarize yourself with the code and try to follow the same syntax conventions to make it easier for us to accept your pull requests. + +The following instructions are common for all Vaadin components. **Replace `vaadin-combo-box` with any other component in the following examples**. Check the component readmes for any special development notes. + +### Getting the code + +1. Clone the component project from GitHub: + + ```shell + $ git clone https://github.com/vaadin/vaadin-combo-box.git + ``` + +2. Install [Node](https://nodejs.org/en/download/). It comes bundled with [npm](https://npmjs.com), which is needed to install other tooling. + +3. Install [Bower](http://bower.io) using [npm](https://npmjs.com): + + ```shell + $ npm install -g bower + ``` + + > If you encounter permission issues when running `npm` see the article about [fixing npm permissions](https://docs.npmjs.com/getting-started/fixing-npm-permissions) on npmjs.com + +4. Use Bower to install the dependencies of the component: + + ```shell + $ cd vaadin-combo-box + $ bower install + ``` + +### Running demos + +1. Install [Polymer CLI](https://github.com/Polymer/polymer-cli) using [npm](https://npmjs.com): + + ```shell + $ npm install -g polymer-cli + ``` + +2. Start a local server in the project root directory: + + ```shell + $ cd vaadin-combo-box + $ polymer serve --port 8080 + ``` + +3. Open the following URLs in your browser: + - Demo: http://localhost:8080/components/vaadin-combo-box/demo/ + - Generated API documentation: http://localhost:8080/components/vaadin-combo-box/ + +### Running tests + +Install [Web Component Tester](https://github.com/Polymer/web-component-tester) using [npm](https://npmjs.com): +```shell +$ npm install -g web-component-tester +``` + +Tests can be run with the `wct` task from the component directory: + +```shell +$ cd vaadin-combo-box +$ wct +``` + +You can also run and debug the tests manually: +```shell +$ cd vaadin-combo-box +$ polymer serve --port 8080 +``` +- Open http://localhost:8080/components/vaadin-combo-box/test/ in your browser. + +You should include new tests in your pull requests if you add features to the components or if you are fixing a bug. + +### Documentation + +We follow the same [style guide](https://www.polymer-project.org/2.0/docs/tools/documentation) as Polymer. + +### Contributor License Agreement + +When you send a pull request to any of our repositories, you get an automated comment response about the CLA. It will notify you if you haven’t signed the CLA yet, and in that case instructions how to do it. You need to do this once per each repository. Before we can accept any of your code contributions, you need to sign the CLA.
\ No newline at end of file @@ -1,7 +1,73 @@ -[](https://gitter.im/vaadin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) + +[](https://www.webcomponents.org/author/vaadin) +[](https://gitter.im/vaadin/web-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -Vaadin is a web development platform that enables you to create modern and fast web applications. +# Vaadin components -Note: https://github.com/vaadin/vaadin was earlier the main repository for -Vaadin Framework. That repository is now available at -https://github.com/vaadin/framework +[Vaadin components](https://vaadin.com/components) is an evolving set of high-quality user interface web components commonly needed in modern mobile and desktop business web applications. The following components are included: + +| Component | Bower Version | Build Status | Polymer 2 support | Polymer 3 support | +|---------|---------------|--------------|-------------------|-------------------| +| [vaadin-board](https://github.com/vaadin/vaadin-board)* |  | [](https://travis-ci.org/vaadin/vaadin-board) |  | | +| [vaadin-button](https://github.com/vaadin/vaadin-button) |  | [](https://travis-ci.org/vaadin/vaadin-button) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-button) | +| [vaadin-charts](https://github.com/vaadin/vaadin-charts)* |  | [](https://travis-ci.org/vaadin/vaadin-charts) |  | | +| [vaadin-checkbox](https://github.com/vaadin/vaadin-checkbox) |  | [](https://travis-ci.org/vaadin/vaadin-checkbox) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-checkbox) | +| [vaadin-combo-box](https://github.com/vaadin/vaadin-combo-box) |  | [](https://travis-ci.org/vaadin/vaadin-combo-box) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-combo-box) | +| [vaadin-context-menu](https://github.com/vaadin/vaadin-context-menu) |  | [](https://travis-ci.org/vaadin/vaadin-context-menu) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-context-menu) | +| [vaadin-date-picker](https://github.com/vaadin/vaadin-date-picker) |  | [](https://travis-ci.org/vaadin/vaadin-date-picker) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-date-picker) | +| [vaadin-dialog](https://github.com/vaadin/vaadin-dialog) |  | [](https://travis-ci.org/vaadin/vaadin-dialog) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-dialog) | +| [vaadin-dropdown-menu](https://github.com/vaadin/vaadin-dropdown-menu) |  | [](https://travis-ci.org/vaadin/vaadin-dropdown-menu) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-dropdown-menu) | +| [vaadin-form-layout](https://github.com/vaadin/vaadin-form-layout) |  | [](https://travis-ci.org/vaadin/vaadin-form-layout) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-form-layout) | +| [vaadin-grid](https://github.com/vaadin/vaadin-grid) |  | [](https://travis-ci.org/vaadin/vaadin-grid) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-grid) | +| [vaadin-icons](https://github.com/vaadin/vaadin-icons) |  | [](https://travis-ci.org/vaadin/vaadin-icons) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-icons) | +| [vaadin-item](https://github.com/vaadin/vaadin-item) |  | [](https://travis-ci.org/vaadin/vaadin-item) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-item) | +| [vaadin-list-box](https://github.com/vaadin/vaadin-list-box) |  | [](https://travis-ci.org/vaadin/vaadin-list-box) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-list-box) | +| [vaadin-notification](https://github.com/vaadin/vaadin-notification) |  | [](https://travis-ci.org/vaadin/vaadin-notification) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-notification) | +| [vaadin-ordered-layout](https://github.com/vaadin/vaadin-ordered-layout) |  | [](https://travis-ci.org/vaadin/vaadin-ordered-layout) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-ordered-layout) | +| [vaadin-progress-bar](https://github.com/vaadin/vaadin-progress-bar) |  | [](https://travis-ci.org/vaadin/vaadin-progress-bar) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-progress-bar) | +| [vaadin-radio-button](https://github.com/vaadin/vaadin-radio-button) |  | [](https://travis-ci.org/vaadin/vaadin-radio-button) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-radio-button) | +| [vaadin-split-layout](https://github.com/vaadin/vaadin-split-layout) |  | [](https://travis-ci.org/vaadin/vaadin-split-layout) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-split-layout) | +| [vaadin-tabs](https://github.com/vaadin/vaadin-tabs) |  | [](https://travis-ci.org/vaadin/vaadin-tabs) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-tabs) | +| [vaadin-text-field](https://github.com/vaadin/vaadin-text-field) |  | [](https://travis-ci.org/vaadin/vaadin-text-field) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-text-field) | +| [vaadin-upload](https://github.com/vaadin/vaadin-upload) |  | [](https://travis-ci.org/vaadin/vaadin-upload) |  | [](https://badge.fury.io/js/%40vaadin%2Fvaadin-upload) | + +Components marked with a `*` are part of the [Vaadin Pro Subscription](https://vaadin.com/pricing), other components are licensed under the Apache License 2.0. + + +## Learn more + +See the list of components, demos and documentation, instructions how to get started, video tutorials, application demos and more by visiting: + +### [vaadin.com/components ›](https://vaadin.com/components) + +--- + +## Contributing + +We would absolutely love to get the community involved, and we welcome any form of contributions – comments and questions on different communication channels, issues and pull request in the repositories, and anything that you build and share using our components. + +### Get in touch with the team + +The chat and the forum category are dedicated channels for this project, while the Twitter, Facebook and G+ pages are common for all Vaadin related discussion (including the Java framework). + +- [Chat](https://gitter.im/vaadin/web-components) +- [Forum](https://vaadin.com/forum/#!/category/9848927) +- [Twitter](https://twitter.com/vaadin) +- [Facebook](https://www.facebook.com/vaadin/) +- [G+](https://plus.google.com/communities/108116678608923665301) + +### Some ways to help: + +- **Test the components and provide feedback**: We would love to hear your feedback on anything related to the components, like features, API and design. The best way to start is by [trying them out](https://vaadin.com/components/browse). And to get a quick response, either drop a question/comment on the chat or open an issue in GitHub. +- **Report bugs**: File issues for the components in their respective GitHub projects. You can find links to them from the list in this readme. +- **Send pull requests**: If you want to contribute code, check out the development instructions below. + +We encourage you to read the [contribution instructions by GitHub](https://guides.github.com/activities/contributing-to-open-source/#contributing) also. + +## Development + +If you want to develop the components yourself see the [development instructions](DEVELOPMENT.md) that apply to all Vaadin components. + +## License + +Apache License 2.0 or CVAL 3.0 depending on the component |