Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 2.13 KB

README.md

File metadata and controls

59 lines (36 loc) · 2.13 KB
Raw

OCE Kit

A react components library for the co-op ecosystem, built with StorybookJs.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

You need nodejs and npm installed on your machine. The OCE KIT is built with StorybookJs, to successfully run the kit locally you need to have installed also storybook module globally on your machine.

npm i -g @storybook/cli

Run OCE Kit on your machine locally

In order to have a local version of OCE Kit running on your machine you will need to follow these steps:

git clone [email protected]:opencooperativeecosystem/kit.git
cd kit
npm install
npm run storybook

Running the tests

Each component is shipped with its own story. The story acts as UI test.

Built With

  • StorybookJs - Interactive UI component dev & test: React, React Native, Vue, Angula
  • React - The web framework used
  • styled-component - Visual primitives for the component age. Use the best bits of ES6 and CSS to style your apps without stress 💅
  • webpack - Javascript bundler

Contributing

[TODO]

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Docs

You can read more about Agent and OCE on our website and docs

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the AGPL 3.0 License