Skip to content

Getting Started

Jump to bottom
Hong-Kuan Wu edited this page Jan 15, 2023 · 1 revision

Please follow these steps to get started with this template:

1. Clone it!

git clone git@github.com:maxam2017/react-lib-template.git --depth=1

2. Replace {{ name }} with your component's name.

This should match your repository name as expected.

3. Don't forget to update the name and description fields in package.json.

By default, this is a scoped package. If you want to remove the scope, just update the package name.

4. Create a new repository

Don't forget to set up protected branches for safety (recommended)

5. Set up secrets for workflows

a. GH_TOKEN

If you're using semantic-release with a private repository + release branch is protected branch, the token needs the following permissions:

  • code: for creating a release commit
  • commit status: update status of latest commit in release branch
  • issue: create issue if release failed
  • pull request: create comment on pull request if release is successful

b. NPM_TOKEN

Please generate npm access token via https://www.npmjs.com/settings/{USERNAME}/tokens/new

--- END ---

Clone this wiki locally