Skip to content
/ react-template Public template

template repo for React projects with everything setup

License

Notifications You must be signed in to change notification settings

will-molloy/react-template

Repository files navigation

react-template

build codecov

template repo for React projects

Features

Usage

  • Click Use this template
    • This will prompt you to create a new repo with all the files setup
  • Rename the project (currently react-template) to your liking
  • Configure GitHub Pages to point at the gh-pages branch
  • Delete anything you won't use
  • Update the README
  • Other non-code setup like GitHub branch protections
  • NOTE: if creating a private repo, you probably want to disable the windows and mac builds

Install dependencies and start

pnpm install
pnpm dev

Format code

pnpm lint --fix
pnpm lint:css --fix

Test

pnpm test

Build and deploy

NOTE: GitHub Actions will deploy automatically on commit to main

pnpm build
pnpm deploy

The site will be available at: https://{github_username}.github.io/{project_name}/


Generated from react-template