c3e5caf110
* docs(examples): improve DX while copy command to create new project * chore: apply code review Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com> Co-authored-by: JJ Kasper <jj@jjsweb.site>
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
# Stenciljs example
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
|
|
|
|
[](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-stencil&project-name=with-stencil&repository-name=with-stencil)
|
|
|
|
## How to use
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/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
|
|
```
|
|
|
|
```bash
|
|
yarn create next-app --example with-stencil with-stencil-app
|
|
```
|
|
|
|
```bash
|
|
pnpm create next-app --example with-stencil with-stencil-app
|
|
```
|
|
|
|
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|
|
|
|
> Choose `packages/web-app` as root directory when deploying.
|
|
|
|
## 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)
|