gnehcwu/user-story

A user stories web component

<user-story>

A stories webcomponent with friendly navigation.

Follows the open-wc recommendation.

user-story.mp4

Installation

npm i user-story

Usage

<script type="module">
  import 'user-story/user-story.js';
</script>

<user-story .stories="${stories}"></user-story>

Local Demo with web-dev-server

npm start

To run a local development server that serves the basic demo located in demo/index.html

Linting with ESLint, Prettier, and Types

To scan the project for linting errors, run

npm run lint

You can lint with ESLint and Prettier individually as well

npm run lint:eslint

npm run lint:prettier

To automatically fix many linting errors, run

npm run format

You can format using ESLint and Prettier individually as well

npm run format:eslint

npm run format:prettier