@25sprout/react-starter

25sprout web starter with React

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@25sprout/react-starter
Minified + gzip package size for @25sprout/react-starter in KB

Readme

React Starter

Commitizen friendly Standard Version

新芽網路前端開發架構

簡介

提供 command line tool 快速建立 react 專案,專案內容主要在 template 資料夾底下。

如何開始

Starter 有上 npm ,因此有兩種方法可以安裝 command line tool

  1. npm install -g @25sprout/react-starter
  2. yarn global add @25sprout/react-starter

踏出第一步

安裝完之後就可以使用 react-starter 指令

  • react-starter -h: 看目前指令支援哪些參數
  • react-starter -V: 目前指令版本
  • react-starter -n react-project: 產生一個 react-new-project 專案,裡面內建 react-starter 環境
  • react-starter -n react-typescript-project -t: 產生一個 react-typescript-project 專案,裡面內建 typescript 的 react-starter 環境

Contribution

此專案 commit message 使用 angular format ,並使用 commitizen 輔助產生 commit message

  • 加入修改的檔案 git add .
  • 產生 commit message npm run commit

Release

此專案使用 standard-version 輔助 release 流程,自動產生 CHANGELOG.md 和 提升版本號(提升 major version 依據是否有 feat 來判斷)

  • npm run release

可以自己決定 提升 patch, minor or major

  • npm run release -- --release-as minor

Warning: 第一次 release 請下

  • npm run release -- --first-release

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.