Skip to content

Latest commit

 

History

History
73 lines (57 loc) · 1.98 KB

README.md

File metadata and controls

73 lines (57 loc) · 1.98 KB

React Shadcn Starter

React + Vite + TypeScript template for building apps with shadcn/ui.

Getting Started

npx degit hayyi2/react-shadcn-starter my-project
cd my-project
npm install
npm run dev

Getting Done

  • Single page app with navigation and responsif layout
  • Customable configuration /config
  • Simple starting page/feature /pages
  • 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
# on:
#   workflow_dispatch:
on:
  push:
    branches: ["main"]

Features

Project Structure

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 file for details.