rsnext/examples/with-paste-typescript
Dominic Elm d2caaeab64
docs: add 'Open in StackBlitz' buttons to various examples (#25853)
This PR adds a `Preview` section and a `Open in StackBlitz` button to various examples. I have tested all examples and omitted the ones that require third party API keys, or didn't work. Some examples don't work locally either.

Here's an example:
![image](https://user-images.githubusercontent.com/12571019/121027783-88971280-c7a7-11eb-851a-0ad30cf74b42.png)

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [x] Examples updated
- [ ] Telemetry added. In case of a feature if it's used or not.

## Documentation / Examples

- [x] Make sure the linting passes
2021-06-08 20:45:02 +00:00
..
pages Fix deploy buttons URLs (#20834) 2021-01-07 01:40:29 +00:00
public feat: add Twilio Paste example (#20587) 2021-01-06 13:49:57 -05:00
.gitignore feat: add Twilio Paste example (#20587) 2021-01-06 13:49:57 -05:00
next-env.d.ts feat: add Twilio Paste example (#20587) 2021-01-06 13:49:57 -05:00
package.json feat: add Twilio Paste example (#20587) 2021-01-06 13:49:57 -05:00
README.md docs: add 'Open in StackBlitz' buttons to various examples (#25853) 2021-06-08 20:45:02 +00:00
tsconfig.json feat: add Twilio Paste example (#20587) 2021-01-06 13:49:57 -05:00

Example app with Paste and TypeScript

This example features how to use Paste as the component library within a Next.js app with TypeScript.

Next.js and Paste have built-in TypeScript declarations, so you'll get autocompletion for their modules straight away.

pages/_app.tsx is used to connect Paste's Theme Provider so the pages can have app-wide styles.

Preview

Preview the example live on StackBlitz:

Open in StackBlitz

Deploy your own

Deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example with-paste-typescript with-paste-typescript-app
# or
yarn create next-app --example with-paste-typescript with-paste-typescript-app

Deploy it to the cloud with Vercel (Documentation).