https://github.com/phatnguyenuit/create-react-app-typescript-template
Create React App TypeScript template
https://github.com/phatnguyenuit/create-react-app-typescript-template
codecov react typescript-template
Last synced: 4 months ago
JSON representation
Create React App TypeScript template
- Host: GitHub
- URL: https://github.com/phatnguyenuit/create-react-app-typescript-template
- Owner: phatnguyenuit
- License: mit
- Created: 2020-08-03T06:42:34.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-12-09T12:00:29.000Z (about 5 years ago)
- Last Synced: 2025-01-10T14:59:36.727Z (11 months ago)
- Topics: codecov, react, typescript-template
- Language: TypeScript
- Homepage: https://phatnguyenuit.github.io/create-react-app-typescript-template
- Size: 361 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# create-react-app-typescript-template
[](https://codecov.io/gh/phatnguyenuit/create-react-app-typescript-template)
Create React App TypeScript template
## Features
- Inherit from package [`cra-template-typescript`](https://www.npmjs.com/package/cra-template-typescript)
- Configure `eslint` with `prettier`
- Configure [`husky`](https://typicode.github.io/husky/#/)
- Configure [`lint-staged`](https://github.com/okonet/lint-staged#readme)
- Configure [`prettier`](https://prettier.io/)
- Configure [`commitlint`](https://commitlint.js.org/)
- Configure [`release-it`](https://github.com/release-it/release-it)
- Add default `jest` test coverage options
- Configure sample GitHub actions including test, release and deploy
- Provide sample vscode snippets
# Configure
- Update `jest` test coverage options of file [`package.json`](./package.json)
- Add secrets at `https://github.com/:user_name/:repository_name/settings/secrets/actions`
- Add `CODECOV_TOKEN` got from `https://codecov.io/gh/:user_name/:repository_name/`
- Add `DEPLOY_ACCESS_TOKEN` got from [`Personal access tokens`](https://github.com/settings/tokens) with the first four `repo` options checked
- Update source for above badges by your own
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.
### `yarn test`
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `yarn build`
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
### `yarn eject`
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
### `yarn commit`
Commit with conventional commit powered by `@commitlint/cli` CLI
### `yarn release`
Release version for your project powered by `release-it` CLI
## Learn More
- You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
- Learn React, check out the [React documentation](https://reactjs.org/).
- Learn [GitHub Actions](https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions)
- Learn [ESLint](https://eslint.org/docs/user-guide/getting-started)
- Learn [Commitlint](https://commitlint.js.org/#/)
- Learn [Release-it](https://github.com/release-it/release-it)
- [Setting up a CI/CD workflow on GitHub Actions for a React App (with GitHub Pages and Codecov)](https://dev.to/dyarleniber/setting-up-a-ci-cd-workflow-on-github-actions-for-a-react-app-with-github-pages-and-codecov-4hnp)