Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ranitmanik/react.shadcn.js-template
This repository provides a streamlined template for building modern web applications using React, Vite, Tailwind, JavaScript and ShadcnUI. It offers a solid foundation for developers looking to create responsive and visually appealing user interfaces quickly.
https://github.com/ranitmanik/react.shadcn.js-template
frontend-template javascript reactjs shadcn-react shadcn-template shadcn-ui shadcn-ui-boilerplate shadcn-ui-starter tailwindcss template-project vite
Last synced: 23 days ago
JSON representation
This repository provides a streamlined template for building modern web applications using React, Vite, Tailwind, JavaScript and ShadcnUI. It offers a solid foundation for developers looking to create responsive and visually appealing user interfaces quickly.
- Host: GitHub
- URL: https://github.com/ranitmanik/react.shadcn.js-template
- Owner: RanitManik
- License: mit
- Created: 2024-07-31T19:01:43.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-08-03T18:07:52.000Z (5 months ago)
- Last Synced: 2024-11-24T20:44:46.498Z (28 days ago)
- Topics: frontend-template, javascript, reactjs, shadcn-react, shadcn-template, shadcn-ui, shadcn-ui-boilerplate, shadcn-ui-starter, tailwindcss, template-project, vite
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
React.shadcn.JS-Template
Welcome to the **React.shadcn.JS-Template**! This template is a robust starting point for
building modern web applications using Vite and React with ShadcnUI, a design system for creating beautiful and
consistent UIs.
## Table of Contents
- [Overview](#overview)
- [Why This Template?](#why-this-template)
- [Technologies Used](#technologies-used)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Development Server](#running-the-development-server)
- [Building for Production](#building-for-production)
- [Linting and Formatting](#linting-and-formatting)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [Contact](#contact)
- [Acknowledgments](#acknowledgments)
## Overview
### Why This Template?
This template is designed to kickstart your project development with modern technologies and design practices. It
integrates React, Vite, Tailwind CSS, and ShadcnUI to help you build aesthetically pleasing and performant web
applications with ease.
This template is a work in progress and will continue to evolve. We encourage you to suggest improvements by forking
this repo, creating a pull request, or opening an issue. Your contributions are greatly appreciated!
### Technologies Used
### Features
- **React**: A powerful JavaScript library for building user interfaces.
- **Vite**: A next-generation frontend tooling. It's fast and efficient, perfect for modern web development.
- **Tailwind CSS**: A utility-first CSS framework for rapid UI development.
- **ShadcnUI**: A design system that provides components and utilities for creating consistent and elegant UIs.
- **JavaScript**: The core programming language for web development.
- **PostCSS**: A tool for transforming CSS with JavaScript plugins.
- **ESLint**: Code linting to maintain consistent code quality.
- **Prettier**: Code formatting to ensure a consistent code style.
## Getting Started
### Prerequisites
- **Node.js** (>= 20.0.0)
- **npm** (>= 10.0.0) or **yarn** (>= 1.22.0)
### Installation
1. **Clone the repository:**
```bash
git clone https://github.com/RanitManik/React.shadcn.JS-Template.git
cd React.shadcn.JS-Template
```
2. **Install dependencies:**
```bash
npm install
```
or
```bash
yarn install
```
### Running the Development Server
To start the development server, run:
```bash
npm run dev
```
or
```bash
yarn dev
```
Open your browser and navigate to `http://localhost:5173` to see the application in action.
### Building for Production
To build the application for production, run:
```bash
npm run build
```
or
```bash
yarn build
```
The built files will be located in the `dist` directory.
### Linting and Formatting
To lint your code, run:
```bash
npm run lint
```
or
```bash
yarn lint
```
To format your code, run:
```bash
npm run format
```
or
```bash
yarn format
```
## Project Structure
The project structure is as follows:
```
├── components.json # Component metadata
├── index.html # HTML template
├── LICENSE # License information
├── package.json # Project dependencies and scripts
├── package-lock.json # Lock file for dependencies
├── postcss.config.js # PostCSS configuration
├── public # Static assets
│ └── vite.svg # Vite logo
├── README.md # Project documentation
├── src # Main source code
│ ├── App.jsx # Main application component
│ ├── components # All components
│ │ └── ui # Reusable ShadcnUI components
│ │ └── button.jsx # Shadcn Button component
│ ├── index.css # Global styles
│ ├── lib # Utility functions
│ │ └── utils.js # Utility functions
│ └── main.jsx # Entry point for React application
├── tailwind.config.js # Tailwind CSS configuration
├── tsconfig.json # TypeScript configuration
├── tsconfig.node.json # TypeScript configuration for Node.js
└── vite.config.js # Vite configuration file
```
## Contributing
We welcome contributions to enhance the React.shadcn.JS-Template project. To contribute:
1. Fork the repository.
2. Create a new branch for your feature or bug fix:
```bash
git checkout -b feature-name
```
3. Make your changes and commit them with clear and descriptive messages.
4. Push your changes to your fork:
```bash
git push origin feature-name
```
5. Create a pull request to the main repository, detailing the changes and enhancements you have made.
## Contact
- **LinkedIn**: [Ranit Manik](https://www.linkedin.com/in/ranit-manik/)
- **GitHub**: [RanitManik](https://github.com/RanitManik)
- **Email**: [[email protected]](mailto:[email protected])
_Feel free to reach out if you have questions or just want to chat about web adventures!_
## Acknowledgments
- [Markdown Badges](https://github.com/Ileriayo/markdown-badges)
- [shields.io Badges](https://shields.io/)
- [Skill Icons](https://github.com/tandpfun/skill-icons)
---
Thank you for using the React.shadcn.JS-Template! Happy coding! 🚀