1 | # Accord Project Web Components for Concerto
|
2 |
|
3 | [![downloads](https://img.shields.io/npm/dm/@accordproject/ui-concerto)](https://www.npmjs.com/package/@accordproject/ui-concerto)
|
4 | [![npm version](https://badge.fury.io/js/%40accordproject%2Fui-concerto.svg)](https://badge.fury.io/js/%40accordproject%2Fui-concerto)
|
5 | [![join slack](https://img.shields.io/badge/Accord%20Project-Join%20Slack-blue)](https://accord-project-slack-signup.herokuapp.com/)
|
6 |
|
7 | This repository contains React components for models written in the [Concerto Modeling Language](https://github.com/accordproject/concerto).
|
8 |
|
9 | ### Installation
|
10 |
|
11 | ```sh
|
12 | npm install @accordproject/ui-concerto
|
13 | ```
|
14 |
|
15 | ### Develop inside Storybook
|
16 |
|
17 | While Storybook is running, if you make a change in a package that you want to see reflected in the demo, in a new terminal:
|
18 |
|
19 | ```sh
|
20 | cd packages/ui-concerto
|
21 | npm run build
|
22 | ```
|
23 |
|
24 | Storybook will reload with the applied changes.
|
25 |
|
26 | ---
|
27 |
|
28 | <a href="https://www.accordproject.org/">
|
29 | <img src="../../assets/APLogo.png" alt="Accord Project Logo" width="400" />
|
30 | </a>
|
31 |
|
32 | Accord Project is an open source, non-profit, initiative working to transform contract management and contract automation by digitizing contracts. Accord Project operates under the umbrella of the [Linux Foundation][linuxfound]. The technical charter for the Accord Project can be found [here][charter].
|
33 |
|
34 | ## Learn More About Accord Project
|
35 |
|
36 | ### [Overview][apmain]
|
37 |
|
38 | ### [Documentation][apdoc]
|
39 |
|
40 | ## Contributing
|
41 |
|
42 | The Accord Project technology is being developed as open source. All the software packages are being actively maintained on GitHub and we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code.
|
43 |
|
44 | Find out what’s coming on our [blog][apblog].
|
45 |
|
46 | Join the Accord Project Technology Working Group [Slack channel][apslack] to get involved!
|
47 |
|
48 | For code contributions, read our [CONTRIBUTING guide][contributing] and information for [DEVELOPERS][developers].
|
49 |
|
50 | ### README Badge
|
51 |
|
52 | Using Accord Project? Add a README badge to let everyone know: [![accord project](https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg)](https://www.accordproject.org/)
|
53 |
|
54 | ```
|
55 | [![accord project](https://img.shields.io/badge/powered%20by-accord%20project-19C6C8.svg)](https://www.accordproject.org/)
|
56 | ```
|
57 |
|
58 | ## License <a name="license"></a>
|
59 |
|
60 | Accord Project source code files are made available under the [Apache License, Version 2.0][apache].
|
61 | Accord Project documentation files are made available under the [Creative Commons Attribution 4.0 International License][creativecommons] (CC-BY-4.0).
|
62 |
|
63 | Copyright 2018-2019 Clause, Inc. All trademarks are the property of their respective owners. See [LF Projects Trademark Policy](https://lfprojects.org/policies/trademark-policy/).
|
64 |
|
65 | [linuxfound]: https://www.linuxfoundation.org
|
66 | [charter]: https://github.com/accordproject/governance/blob/master/accord-project-technical-charter.md
|
67 | [apmain]: https://accordproject.org/
|
68 | [apblog]: https://medium.com/@accordhq
|
69 | [apdoc]: https://docs.accordproject.org/
|
70 | [apslack]: https://accord-project-slack-signup.herokuapp.com
|
71 |
|
72 | [storybook]: https://ap-web-components.netlify.app/
|
73 |
|
74 | [contributing]: https://github.com/accordproject/web-components/blob/master/CONTRIBUTING.md
|
75 | [developers]: https://github.com/accordproject/web-components/blob/master/DEVELOPERS.md
|
76 |
|
77 | [apache]: https://github.com/accordproject/web-components/blob/master/LICENSE
|
78 | [creativecommons]: http://creativecommons.org/licenses/by/4.0/ |
\ | No newline at end of file |