This monorepo template allows you to start immediately with a React (TypeScript) single-page application, but it can also be used for any other type of web app.
The template takes away the work of having to assemble and configure all the tools for professional development yourself.
-
Clone the template:
npx degit kporten/template-react my-project
-
Replace all occurrences of
template-react
andTemplate React
with the name of your project. -
Adjust the information (e.g. the author name) in the files
package.json
,LICENSE
,CHANGELOG.md
andREADME.md
. -
Execute the following commands in your terminal:
pnpm install
pnpm dev
๐ Now you can get up and running with your ideas!
# run all dev servers in parallel during development
pnpm dev
# build all workspaces
pnpm build
# run all preview servers in parallel
pnpm preview
# lint all workspaces
pnpm lint
# run tests for each workspace
pnpm test
# run tests and check coverage for each workspace
pnpm test:coverage
# run type checks for each workspace
pnpm typecheck
# format repo files
pnpm format
# describe a feat/fix changes and add the changeset
pnpm changeset
# update version and create tags
pnpm release
push
pull_request
security
run https://github.com/snyk/actionslicenses
run https://github.com/fossas/fossa-actiontest
- run typecheck
- run lint
- run tests and check coverage threshold
build
- needs all other jobs were successful
- run on push and only for the main branch
- build apps
- upload builded apps as artifact
FOSSA_API_KEY
see https://docs.fossa.com/docs/api-referenceSNYK_TOKEN
see https://docs.snyk.io/features/user-and-group-management/authentication/authentication-for-third-party-tools
The following tools are used in this monorepo:
The root of the repository includes the following tools:
MIT License
Copyright (c) 2022 Kevin Porten