UNPKG

@skhemata/skhemata-crowdfunding-campaign

Version:

Skhemata Crowdfunding Campaign Web Component. This web component provides crowdfunding campaign functionality (reward/donation based) for a website.

81 lines (62 loc) 1.74 kB
# \<skhemata-crowdfunding-campaign> Skhemata Crowdfunding Campaign Web Component. This web component provides crowdfunding campaign functionality (reward/donation based) for a website. ## Installation ```bash npm i skhemata-crowdfunding-campaign ``` ## Usage ```html <script type="module"> import 'skhemata-crowdfunding-campaign/skhemata-crowdfunding-campaign.js'; </script> <skhemata-crowdfunding-campaign></skhemata-crowdfunding-campaign> ``` ## Linting with ESLint, Prettier, and Types To scan the project for linting errors, run ```bash npm run lint ``` You can lint with ESLint and Prettier individually as well ```bash npm run lint:eslint ``` ```bash npm run lint:prettier ``` To automatically fix many linting errors, run ```bash npm run format ``` You can format using ESLint and Prettier individually as well ```bash npm run format:eslint ``` ```bash npm run format:prettier ``` ## Testing with Web Test Runner To run the suite of Web Test Runner tests, run ```bash npm run test ``` To run the tests in watch mode (for &lt;abbr title=&#34;test driven development&#34;&gt;TDD&lt;/abbr&gt;, for example), run ```bash npm run test:watch ``` ## Demoing with Storybook To run a local instance of Storybook for your component, run ```bash npm run storybook ``` To build a production version of Storybook, run ```bash npm run storybook:build ``` ## Tooling configs For most of the tools, the configuration is in the `package.json` to reduce the amount of files in your project. If you customize the configuration a lot, you can consider moving them to individual files. ## Local Demo with `web-dev-server` ```bash npm start ``` To run a local development server that serves the basic demo located in `demo/index.html`