North Pole Mysteries

    inclusive-web-components
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.16 • Public • Published

    Contributors Forks Stargazers Issues MIT License LinkedIn


    Table of Contents
    1. About The Project
    2. Getting Started
    3. Usage
    4. Roadmap
    5. Contributing
    6. License
    7. Contact
    8. Acknowledgments

    About The Project

    Web components library port of Inclusive components

    Built With

    (back to top)

    Getting Started

    This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

    Prerequisites

    This is an example of how to list things you need to use the software and how to install them.

    • node
    • npm
      npm install npm@latest -g
      

    Installation

    1. Clone the repo git clone https://github.com/fstbraz/inclusive-web-components.git

    2. Install NPM packages

      npm install
      
    3. The remainig commands for buid and testing are listed at package.json

    (back to top)

    Usage

    Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources. (WIP)

    For more examples, please refer to the Documentation

    (back to top)

    Roadmap

    • [X] Initial Setup
    • [X] First Component
    • [ ] Unit Tests Setup
    • [ ] Migrate the remaining components
    • [ ] Storybook configuration
    • [ ] Migrate to eslint
    • [ ] Improvements

    See the open issues for a full list of proposed features (and known issues).

    (back to top)

    Contributing

    Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

    If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

    1. Fork the Project
    2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
    3. Commit your Changes (git commit -m 'Add some AmazingFeature')
    4. Push to the Branch (git push origin feature/AmazingFeature)
    5. Open a Pull Request

    (back to top)

    License

    Distributed under the MIT License. See LICENSE for more information.

    (back to top)

    Contact

    Twitter - @fstbraz

    Project Link: https://github.com/fstbraz/inclusive-web-components

    (back to top)

    Install

    npm i inclusive-web-components

    DownloadsWeekly Downloads

    14

    Version

    0.0.16

    License

    MIT

    Unpacked Size

    21.6 kB

    Total Files

    9

    Last publish

    Collaborators

    • fst.braz