react-declarative · Nov 18, 2024
diff --git a/‎.gitignore
+24 b/‎.gitignore
+24
diff --git a/‎README.md
+77 b/‎README.md
+77
diff --git a/‎components.json
+16 b/‎components.json
+16
diff --git a/‎index.html
+13 b/‎index.html
+13
@@ -0,0 +1,24 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+dist
+dist-ssr
+*.local
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
@@ -0,0 +1,77 @@
+# React Shadcn Starter
+
+React + Vite + TypeScript template for building apps with shadcn/ui.
+
+## Getting Started
+
+```
+git clone https://github.com/hayyi2/react-shadcn-starter.git new-project
+cd new-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
+- [react-router-dom](https://www.npmjs.com/package/react-router-dom)
+- [shadcn-ui](https://github.com/shadcn-ui/ui/)
+- [radix-ui/icons](https://www.radix-ui.com/icons)
+
+## Project Structure
+
+```
+react-shadcn-starter/
+├── public/            # Public assets
+├── src/               # Application source code
+│   ├── components/    # React components
+│   │   └── ui/        # shadc/ui components
+│   │   └── layouts/   # layouts components
+│   ├── context/       # contexts components
+│   ├── config/        # Config data
+│   ├── hook/          # Custom hooks
+│   ├── lib/           # Utility functions
+│   ├── pages/         # pages/features components
+│   ├── App.tsx        # Application entry point
+│   ├── index.tsx      # Main rendering file
+│   └── Router.tsx     # Routes component
+├── index.html         # HTML entry point
+├── postcss.config.js  # PostCSS configuration
+├── tailwind.config.js # Tailwind CSS configuration
+├── 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. 
@@ -0,0 +1,16 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "new-york",
+  "rsc": false,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.js",
+    "css": "src/index.css",
+    "baseColor": "slate",
+    "cssVariables": true
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils"
+  }
+}
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>React Shadcn Starter</title>
+  </head>
+  <body class="min-h-screen">
+    <div id="root" class="relative flex min-h-screen flex-col"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>