- ๐ป React suport >=16.8.0
โ๏ธ Project init with vite- ๐ฆ Support cjs & esm
-
๐ช Github Actions support (Auto CI on pull_request / Auto Release on push tag / Auto Deploy on push & pull_request)
-
๐ Build npm package with tsup
-
Build-in Docusaurus
npm run docs
-
๐ญ Built-in react dev environment
playground folder
start -->
npm run dev
-
๐ Use browserslistrc
-
๐ช Build styles with sass &&postcss (postcss-nested/ autoprefixer / cssnano)
-
๐ญ Stylelint that helps you avoid errors and enforce conventions in your styles.
-
๐ Mono repo with npm
-
๐ TypeScript, of course
-
๐ Unit Testing with Vitest
-
๐ Storybook for building UI components and pages
-
๐ง ESLint statically analyzes your code to quickly find problems.
-
โ Husky & lint-staged
-
โ Commitlint that helps your team adhering to a commit convention
-
๐ฅณ MIT License
replace custom-package-name
with your package name
Project
โโโ __tests__ # Unit Testing
โโโ babel.config.js # babel config
โโโ package.json
โโโ playground # dev environment folder (can use source code)
โ โโโ index.html
โ โโโ package.json
โ โโโ public
โ โโโ src
โ โโโ tsconfig.json
โ โโโ vite-env.d.ts
โ โโโ vite.config.ts
โโโ postcss.config.js # build styles with postcss
โโโ src # Package source code
โ โโโ index.ts # Package source entry
โ โโโ stories # storybook for building UI components and pages
โ โโโ styles # styles for Package
โ โโโ types.ts # ts type declaration for Package
โโโ tsconfig.json # ts config
โโโ tsup.config.ts # build package with tsup
- update project setting
settings -> actions -> General
-
then copy npm token, add to github project settings
- project -> settings -> secrets -> actions -> create new token with name:NPM_TOKEN
-
then copy netlify token, add to github project settings
- project -> settings -> secrets -> actions -> create new token with name:NETLIFY_TOKEN
-
create a site on netlify
-
copy the site_id from your netlify site settings, add it to github project settings
- project -> settings -> secrets -> actions -> create new token with name:NETLIFY_SITE_ID
-
Stop Build from Build settings of site
-
run
npx vercel
in project root folder -
open .vercel/project.json
-
copy orgId & projectId, add it to github project settings
- project -> settings -> secrets -> actions -> create new token with name:VERCEL_ORG_ID & VERCEL_PROJECT_ID
-
create vercel token, add it to github project settings
- project -> settings -> secrets -> actions -> create new token with name:VERCEL_TOKEN
-
change project build setting