world-charity-tour / camsol-components

Camsol Components Library

Camsol Components Library

Prerequisites

This project requires NodeJS (version 8 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
6.4.1
v8.16.0

Table of contents

• Camsol Components Library
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Example Usage
  • Useful Docs
  • Contributing
  • Credits
  • Built With
  • Versioning
  • Changelog
  • Security
  • License

Getting Started

Installation

npm install camsol-components-library

OR

npm i camsol-components-library

Example Usage

Button Component

import { Button } from "camsol-components-library";

const App: React.FC = () => {
  return (
    <Button type="Solid" text="Button Text" />
  )
}

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am '<commit-category>: Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request 😎

Built With

• NodeJS
• ReactJS
• TypeScript
• Storybook

Library packaging done with Rollup

Versioning

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

Changelog

Changelog

Security

Security Policy

License

GNU GPLv3

Camsol Innovations GmbH

camsol-components's Issues

Document All Button Types

• Implement all button variants, and display demo via storybook.

• Solid Button Type

• Outlined Button Type

• Text Button Type

• Underlined Button Type

• Badge Button Type

Storybook Deployment

Storybook deployment on GitHub pages.

@lowesilvan please since you are to handle this, please configure the build path to point to the /docs directory. @devsecur did some updates as needed.