@vr33ni/table-stenciljs

Stencil Web Component - Table based on AG Grid

Table of Contents

1. About The Project
   • Built With
2. Project structure
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Local development
6. Contributing
7. Contact

About The Project

This repository contains an implementation of a Table component and it's Storybook sourcecode using Stencil web components.

Use it to build & run storybook and distribute the web component.

Built With

Stencil web components

back to top

Project structure

Overall structure

The repository has a monorepo architecture using Lerna.

---

Getting Started

Prerequisites

• Node > v16 .
• Yarn > v1.22.10, or Npm > v8.

---

General usage of web components

Explore our currently available web components in Storybook. You will also find the code snippets needed to include them in your application.

https://vr33ni.github.io/table-stenciljs

---

Local development

Installation

git clone https://github.com/vr33ni/table-stenciljs.git

Install all the modules and dependencies listed on the package.json file with:

yarn/npm install

back to top

---

Build Storybook

To run Storybook to view and test the Stencil Web Component, you first need to export it as a static web app.

For building the application for the first time (to load fonts, assets and stylesheets) run:

yarn/npm run build:components

Start Storybook

To run storybook locally (automatically rebuilds on changes), run:

yarn/npm run storybook

back to top

---

Contributing

• Clone the repository
• Create an issue with a proper description (Naming convention: 'name-of-component: feature/bug')
• Create a pull request with a proper description
• Request a review

back to top