64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
|
# Stenciljs example
|
||
|
|
|
||
|
|
## Deploy your own
|
||
|
|
|
||
|
|
Deploy the example using [ZEIT Now](https://zeit.co/now):
|
||
|
|
|
||
|
|
[](https://zeit.co/new/project?template=https://github.com/zeit/next.js/tree/canary/examples/with-stencil)
|
||
|
|
|
||
|
|
## How to use
|
||
|
|
|
||
|
|
### Using `create-next-app`
|
||
|
|
|
||
|
|
Execute [`create-next-app`](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) with [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) or [npx](https://github.com/zkat/npx#readme) to bootstrap the example:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npx create-next-app --example with-stencil with-stencil-app
|
||
|
|
# or
|
||
|
|
yarn create next-app --example with-stencil with-stencil-app
|
||
|
|
```
|
||
|
|
|
||
|
|
### Download manually
|
||
|
|
|
||
|
|
Download the example:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-stencil
|
||
|
|
cd with-stencil
|
||
|
|
```
|
||
|
|
|
||
|
|
Build stencil component:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd packages/test-component
|
||
|
|
yarn build
|
||
|
|
```
|
||
|
|
|
||
|
|
Install it and run:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
yarn
|
||
|
|
yarn dev
|
||
|
|
```
|
||
|
|
|
||
|
|
Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download)):
|
||
|
|
|
||
|
|
```bash
|
||
|
|
now
|
||
|
|
```
|
||
|
|
|
||
|
|
## The idea behind the example
|
||
|
|
|
||
|
|
Stencil is a compiler that generates Web Components (more specifically, Custom Elements). Stencil combines the best concepts of the most popular frameworks into a simple build-time tool.
|
||
|
|
|
||
|
|
In this example we have two workspaces:
|
||
|
|
|
||
|
|
- **web-app**: A Next.js app
|
||
|
|
- **test-component**: A stencil components
|
||
|
|
|
||
|
|
## Useful Links
|
||
|
|
|
||
|
|
- [Documentation](https://stenciljs.com/docs/introduction)
|
||
|
|
- [yarn workspaces](https://yarnpkg.com/lang/en/docs/cli/workspace)
|
||
|
|
- [yarn workspace](https://yarnpkg.com/lang/en/docs/cli/workspaces)
|