Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unllamas/personal
https://github.com/unllamas/personal
chakra-ui nextjs personal-website
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/unllamas/personal
- Owner: unllamas
- License: gpl-3.0
- Created: 2022-12-29T10:26:54.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-05T21:41:13.000Z (over 1 year ago)
- Last Synced: 2024-11-24T20:55:20.331Z (about 1 month ago)
- Topics: chakra-ui, nextjs, personal-website
- Language: JavaScript
- Homepage: https://www.jonallamas.com/
- Size: 2.69 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Example app with [chakra-ui](https://github.com/chakra-ui/chakra-ui) and TypeScript
This example features how to use [chakra-ui](https://github.com/chakra-ui/chakra-ui) as the component library within a Next.js app with TypeScript.
Next.js and chakra-ui have built-in TypeScript declarations, so we'll get autocompletion for their modules straight away.
We are connecting the Next.js `_app.js` with `chakra-ui`'s Provider and theme so the pages can have app-wide dark/light mode. We are also creating some components which shows the usage of `chakra-ui`'s style props.
## Deploy your own
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-chakra-ui)
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-chakra-ui&project-name=with-chakra-ui&repository-name=with-chakra-ui)
## How to use
### Using `create-next-app`
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
```bash
npx create-next-app --example with-chakra-ui with-chakra-ui-app
``````bash
yarn create next-app --example with-chakra-ui with-chakra-ui-app
``````bash
pnpm create next-app --example with-chakra-ui with-chakra-ui-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)).
## Notes
Chakra has supported Gradients and RTL in `v1.1`. To utilize RTL, [add RTL direction and swap](https://chakra-ui.com/docs/features/rtl-support).
If you don't have multi-direction app, you should make `` inside `_document.ts`.