An open API service indexing awesome lists of open source software.

https://github.com/skyclouds2001/vite-react-template-sky

An opinionated vite starter template for React.
https://github.com/skyclouds2001/vite-react-template-sky

reactjs template-project vitejs

Last synced: 5 months ago
JSON representation

An opinionated vite starter template for React.

Awesome Lists containing this project

README

          

# vite-react-template-sky

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
![NPM Type Definitions](https://img.shields.io/npm/types/chalk)
![Github Created At](https://img.shields.io/github/created-at/skyclouds2001/vite-react-template-sky)
![GitHub last commit](https://img.shields.io/github/last-commit/skyclouds2001/vite-react-template-sky)
![GitHub Release Date](https://img.shields.io/github/release-date/skyclouds2001/vite-react-template-sky)
![GitHub language count](https://img.shields.io/github/languages/count/skyclouds2001/vite-react-template-sky)
![GitHub top language](https://img.shields.io/github/languages/top/skyclouds2001/vite-react-template-sky)
[![npm](https://img.shields.io/npm/v/%40sky-fly%2Fvite-template)](https://www.npmjs.com/package/%40sky-fly%2Fvite-template)
![NPM Collaborators](https://img.shields.io/npm/collaborators/%40sky-fly%2Fvite-template)
![npms.io](https://img.shields.io/npms-io/final-score/%40sky-fly%2Fvite-template)
![GitHub License](https://img.shields.io/github/license/skyclouds2001/vite-react-template-sky)
![OSS Lifecycle](https://img.shields.io/osslifecycle/skyclouds2001/vite-react-template-sky)

![GitHub repo size](https://img.shields.io/github/repo-size/skyclouds2001/vite-react-template-sky)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/skyclouds2001/vite-react-template-sky)
![Lines of code](https://tokei.rs/b1/github/skyclouds2001/vite-react-template-sky)
![GitHub repo file or directory count](https://img.shields.io/github/directory-file-count/skyclouds2001/vite-react-template-sky)
![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/%40sky-fly%2Fvite-template)
![npm bundle size](https://img.shields.io/bundlephobia/min/%40sky-fly%2Fvite-template)
![npm package minimized gzipped size](https://img.shields.io/bundlejs/size/%40sky-fly%2Fvite-template)
![npm bundle size](https://img.shields.io/bundlephobia/minzip/%40sky-fly%2Fvite-template)

![GitHub package.json version](https://img.shields.io/github/package-json/v/skyclouds2001/vite-react-template-sky)
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/skyclouds2001/vite-react-template-sky)
![GitHub Issues or Pull Requests](https://img.shields.io/github/issues-pr/skyclouds2001/vite-react-template-sky)
![GitHub Discussions](https://img.shields.io/github/discussions/skyclouds2001/vite-react-template-sky)
![GitHub number of milestones](https://img.shields.io/github/milestones/all/skyclouds2001/vite-react-template-sky)
![GitHub Tag](https://img.shields.io/github/v/tag/skyclouds2001/vite-react-template-sky)
![GitHub Release](https://img.shields.io/github/v/release/skyclouds2001/vite-react-template-sky)
![GitHub forks](https://img.shields.io/github/forks/skyclouds2001/vite-react-template-sky?style=flat)
![GitHub watchers](https://img.shields.io/github/watchers/skyclouds2001/vite-react-template-sky?style=flat)
![GitHub Repo stars](https://img.shields.io/github/stars/skyclouds2001/vite-react-template-sky?style=flat)

![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/skyclouds2001/vite-react-template-sky/total)
![NPM Downloads](https://img.shields.io/npm/dy/%40sky-fly%2Fvite-template)
![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hy/%40sky-fly%2Fvite-template)
![GitHub commit activity](https://img.shields.io/github/commit-activity/y/skyclouds2001/vite-react-template-sky)
![GitHub contributors from allcontributors.org](https://img.shields.io/github/all-contributors/skyclouds2001/vite-react-template-sky)

[![ci](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/ci.yml/badge.svg)](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/ci.yml)
[![CodeQL](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/github-code-scanning/codeql)
[![Dependabot Updates](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/dependabot/dependabot-updates)
[![labeler](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/labeler.yml/badge.svg)](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/labeler.yml)
[![new contributor](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/new-contributor.yml/badge.svg)](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/new-contributor.yml)
[![project automate](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/project-automate.yml/badge.svg)](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/project-automate.yml)
[![release](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/release.yml/badge.svg)](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/release.yml)
[![stale](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/stale.yml/badge.svg)](https://github.com/skyclouds2001/vite-react-template-sky/actions/workflows/stale.yml)

![Node Current](https://img.shields.io/node/v/%40sky-fly%2Fvite-template)
[![wakatime](https://wakatime.com/badge/user/bfadeccb-56c3-4aa2-abb0-89cf5f9b89be/project/044a2450-7035-45c6-a7b5-966578a05777.svg)](https://wakatime.com/badge/user/bfadeccb-56c3-4aa2-abb0-89cf5f9b89be/project/044a2450-7035-45c6-a7b5-966578a05777)

An opinionated vite starter template for React.

## Features

- [Vite](https://vitejs.dev/) with [React](https://react.dev/) and [TypeScript](https://www.typescriptlang.org/)
- [React Router](https://reactrouter.com/) for router
- [Redux](https://redux.js.org/) for intuitive store
- [Ant Design](https://ant.design/) for providing UI components library
- [Iconify](https://iconify.design/) for providing rich icons source
- [TailwindCSS](https://tailwindcss.com/) for providing atomic CSS style support
- [Axios](https://axios-http.com/) for making HTTP requests
- [Dayjs](https://day.js.org/) for Date support
- [Lodash-es](https://lodash.com/) for providing tool methods
- PWA support via [vite-plugin-pwa](https://vite-pwa-org.netlify.app/)
- Using [pnpm](https://pnpm.io/) as the package manager and using only-allow to limit package manager
- [Postcss](https://postcss.org/) for transform styles
- [Husky](https://typicode.github.io/husky/) and lint-staged for run lint when commits
- [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [Stylelint](https://stylelint.io/) and MarkdownLint for lint and enforce code and documentation style
- [Commitlint](https://commitlint.js.org/) and [Commitizen](https://commitizen-tools.github.io/commitizen/) for enforce git commit format
- Changeset for automatically generate version change documentation
- [Vitest](https://vitest.dev/) and [Playwright](https://playwright.dev/) for unit, component and e2e test.
- Basic Configuration for GitHub Actions
- [Docker](https://www.docker.com/) and [Nginx](https://nginx.org/) deploy supported
- [Vercel](https://vercel.com/) and [Netlify](https://www.netlify.com/) deploy supported
- [StackBlitz](https://stackblitz.com/) preview supported

## Getting Started

- Get code

```bash
git clone https://github.com/skyclouds2001/vite-react-template-sky.git
```

- Install dependencies

```bash
pnpm install
```

- Run

```bash
pnpm dev
```

- Build

```bash
pnpm build
```

- Preview

```bash
pnpm preview
```

## Changelog

[Changelog](CHANGELOG.md)

## Contribution

[Contribution](CONTRIBUTING.md)

## Contributors

## Code of Conduct

[Code of Conduct](CODE_OF_CONDUCT.md)

## License

[MIT](LICENSE) © skyclouds2001