Overview

The React Shadcn Starter is a template that combines React, Vite, and TypeScript for building applications with the shadcn/ui library. It provides a starting point for creating single page apps with navigation and a responsive layout. The template also includes customizable configuration options, a simple starting page/feature, and the ability to deploy the app to GitHub Pages using GitHub Actions.

Features

• Single page app with navigation and responsive layout: The template allows you to easily create a single page application with a navigation menu and a responsive layout.
• Customizable configuration: You can customize the configuration of the template by modifying the /config directory.
• Simple starting page/feature: The template includes a simple starting page/feature that you can build upon to create your app’s main functionality.
• GitHub Pages deployment: You can deploy the app to GitHub Pages using GitHub Actions. This feature involves changing the basename in /vite.config.ts, creating a deploy key (GITHUB_TOKEN) in GitHub settings/keys, committing and pushing changes, setting up GitHub Pages to the gh-pages branch, and running the “Build & Deploy” action.

Installation

To install the React Shadcn Starter template, follow these steps:

1. Clone the repository.
2. Change the basename in /vite.config.ts to match your app’s desired URL.
3. Create a deploy key named GITHUB_TOKEN in your GitHub repository’s settings/keys.
4. Commit and push the changes to your repository.
5. Set up GitHub Pages to use the gh-pages branch.
6. Run the “Build & Deploy” action to automatically deploy the app to GitHub Pages.

Summary

The React Shadcn Starter is a template that combines React, Vite, and TypeScript to provide a starting point for building applications with the shadcn/ui library. It offers features such as a single page app with navigation and responsive layout, customizable configuration options, a simple starting page/feature, and the ability to deploy the app to GitHub Pages using GitHub Actions. With clear installation instructions and licensing under the MIT License, this template is a valuable resource for developers looking to kickstart their React projects.