https://github.com/glorious-codes/glorious-pitsby-demo-web-components
A simple demo of web components documented with Pitsby
https://github.com/glorious-codes/glorious-pitsby-demo-web-components
documentation-tool es-modules web-components
Last synced: 8 months ago
JSON representation
A simple demo of web components documented with Pitsby
- Host: GitHub
- URL: https://github.com/glorious-codes/glorious-pitsby-demo-web-components
- Owner: glorious-codes
- License: mit
- Created: 2023-01-23T21:50:52.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-30T23:42:54.000Z (over 2 years ago)
- Last Synced: 2025-01-03T09:19:27.001Z (9 months ago)
- Topics: documentation-tool, es-modules, web-components
- Language: JavaScript
- Homepage: https://web-components.pitsby.com/
- Size: 739 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Glorious Pitsby Demo (Web Components)
> Demo documentation generated with https://pitsby.com
[](https://dl.circleci.com/status-badge/redirect/gh/glorious-codes/glorious-pitsby-demo-web-components/tree/main)
[](https://coveralls.io/github/glorious-codes/glorious-pitsby-demo-web-components?branch=main)
## Contributing
1. Install [Node](https://nodejs.org/en/). Download the "Recommend for Most Users" version.
2. Clone the repo:
``` bash
git clone git@github.com:glorious-codes/glorious-pitsby-demo-web-components.git
```
3. Go to the project directory
``` bash
cd glorious-pitsby-demo-web-components
```
4. Install the project dependencies
``` bash
npm install
```
6. Otherwise, run:
``` bash
npm run start
```
The app will be running on `http://localhost:7000`.
## Tests
1. Ensure that all code that you have added is covered with unit tests:
``` bash
npm run test
```
2. You can optionally generate coverage report after running tests:
``` bash
npm run test -- --coverage
```