https://github.com/hayyi2/react-shadcn-starter
React + vite template for building apps with shadcn/ui.
https://github.com/hayyi2/react-shadcn-starter
react shadcnui tailwind typescript vitejs
Last synced: about 2 months ago
JSON representation
React + vite template for building apps with shadcn/ui.
- Host: GitHub
- URL: https://github.com/hayyi2/react-shadcn-starter
- Owner: hayyi2
- License: mit
- Created: 2023-10-15T07:02:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-19T08:19:55.000Z (7 months ago)
- Last Synced: 2025-03-19T08:26:13.717Z (7 months ago)
- Topics: react, shadcnui, tailwind, typescript, vitejs
- Language: TypeScript
- Homepage: https://hayyi2.github.io/react-shadcn-starter/
- Size: 344 KB
- Stars: 38
- Watchers: 1
- Forks: 17
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-shadcnui - Github - shadcn-starter/) | ★51 | (Boilerplates & Starters)
README
# React Shadcn Starter
React + Vite + TypeScript template for building apps with shadcn/ui.
## Getting Started
```bash
npx degit hayyi2/react-shadcn-starter my-project
cd my-project
npm install
npm run dev
```
## Getting Done
- [x] Single page app with navigation and responsif layout
- [x] Customable configuration `/config`
- [x] Simple starting page/feature `/pages`
- [x] Github action deploy github pages
## Deploy `gh-pages`
- change `basenameProd` in `/vite.config.ts`
- create deploy key `GITHUB_TOKEN` in github `/settings/keys`
- commit and push changes code
- setup gihub pages to branch `gh-pages`
- run action `Build & Deploy`
### Auto Deploy
- change file `.github/workflows/build-and-deploy.yml`
- Comment on `workflow_dispatch`
- Uncomment on `push`
```yaml
# on:
# workflow_dispatch:
on:
push:
branches: ["main"]
```
## Features
- React + Vite + TypeScript
- Tailwind CSS
- [shadcn-ui](https://github.com/shadcn-ui/ui/)
- [react-router-dom](https://www.npmjs.com/package/react-router-dom)
## Project Structure
```md
react-shadcn-starter/
├── public/ # Public assets
├── src/ # Application source code
│ ├── components/ # React components
│ ├── context/ # contexts components
│ ├── config/ # Config data
│ ├── hook/ # Custom hooks
│ ├── lib/ # Utility functions
│ ├── pages/ # pages/features components
│ ├── App.tsx # Application entry point
│ ├── index.css # Main css and tailwind configuration
│ ├── main.tsx # Main rendering file
│ └── Router.tsx # Routes component
├── index.html # HTML entry point
├── tsconfig.json # TypeScript configuration
└── vite.config.ts # Vite configuration
```
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/hayyi2/react-shadcn-starter/blob/main/LICENSE) file for details.