https://github.com/break-stuff/fast-element-starter
A template for creating component libraries with Microsoft's Fast Element
https://github.com/break-stuff/fast-element-starter
Last synced: 8 months ago
JSON representation
A template for creating component libraries with Microsoft's Fast Element
- Host: GitHub
- URL: https://github.com/break-stuff/fast-element-starter
- Owner: break-stuff
- Created: 2022-01-25T13:15:06.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-14T14:48:01.000Z (over 4 years ago)
- Last Synced: 2025-04-04T00:25:10.201Z (about 1 year ago)
- Language: TypeScript
- Size: 1.87 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# FAST Element Starter
This is a starter project for a building web component library using [FAST Element](https://www.fast.design/docs/fast-element/getting-started).
## Getting Started
Before getting started, make sure you have installed all dependencies:
```bash
npm install
```
### Starting Dev Environment
---
```bash
npm run dev
```
This command will start up the [Storybook](https://storybook.js.org/docs/web-components/get-started/introduction) environment and run the custom element manifest generator.
### Running on a Local Web Server
---
```bash
npm run serve
```
Sometimes you need to isolate your components for additional testing. Running the `serve` command will start a local web server using the `index.html` file at the root of the project.
## Testing Your Components
```bash
npm run test
-- or --
npm run test:watch
```
These will open up headless browser instances (configured in `web-test-runner.congig.mjs`) and run your automated tests defined in your `*.tests.ts` files.
## Deployment
When preparing your components for deployment, run the `build` command. This will compile all of your files into the `./dist` directory in a format for your package manger to consume.
```bash
npm run build
```