Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/michielbouw/react-typescript-eslint-prettier-boilerplate
Starting point for a Typescript & React project with full setup of ESLint and Prettier.
https://github.com/michielbouw/react-typescript-eslint-prettier-boilerplate
boilerplate boilerplate-template create-react-app create-react-app-typescript eslint eslint-config eslint-config-prettier linter prettier prettier-eslint react react-boilerplate react-template scss tslint tslint-deprecated typescript typescript-boilerplate yarn
Last synced: 2 months ago
JSON representation
Starting point for a Typescript & React project with full setup of ESLint and Prettier.
- Host: GitHub
- URL: https://github.com/michielbouw/react-typescript-eslint-prettier-boilerplate
- Owner: michielbouw
- License: mit
- Created: 2020-05-04T14:30:39.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T04:58:28.000Z (about 2 years ago)
- Last Synced: 2023-02-26T09:32:23.806Z (almost 2 years ago)
- Topics: boilerplate, boilerplate-template, create-react-app, create-react-app-typescript, eslint, eslint-config, eslint-config-prettier, linter, prettier, prettier-eslint, react, react-boilerplate, react-template, scss, tslint, tslint-deprecated, typescript, typescript-boilerplate, yarn
- Language: TypeScript
- Homepage:
- Size: 491 KB
- Stars: 7
- Watchers: 2
- Forks: 7
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Typescript React project boilerplate with ESLint and Prettier
Starting point for a Typescript React project with full setup of SASS/SCSS, ESLint and Prettier for linting and formatting.
## Stack
This project is initialized with [Create React App](https://github.com/facebook/create-react-app) consisting of:
- TypeScript
- React (16+)
- react-scripts (createReactApp)
- react-testing-library (not Enzyme)
- SASS/SCSS
- ESLint (instead of deprecated TSLint)
- Prettier
## Get Started
### Make sure you run Node.js v10+
To install check ([Node.js installation](https://nodejs.org/en/) or [Node Version Manager installation](https://github.com/nvm-sh/nvm)).
### Clone or copy this repo
```bash
curl -L https://github.com/michielbouw/react-typescript-eslint-prettier-boilerplate/archive/master.zip | tar zx
mv react-typescript-eslint-prettier-boilerplate APP_NAME
cd APP_NAME
```
or
```bash
git clone [email protected]:michielbouw/react-typescript-eslint-prettier-boilerplate.git APP_NAME
cd APP_NAME
```
### `yarn install` (or `npm install`)
Note: this project is initialized with [Yarn]() and it's recommended to use it,
but instead you could also use `npm` for all scripts and please remove the yarn.lock file if you do so.
## Development Scripts
In the project directory, you can run:
### `yarn start` (or `npm 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 typecheck` (or `npm run typecheck`)
Launches the typescript check for code to check for TypeScript compilation errors or warnings.
### `yarn lint` (or `npm run lint`)
Launches the linter for code to check for code layout errors or warnings.
### `yarn lint:fix` (or `npm run lint:fix`)
Launches the linter for code to check for code layout errors or warnings, and fixes the ones that can be fixed automatically.
### `yarn test` (or `npm run 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.
## Production Scripts
### `yarn build` (or `npm run 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.
## Learn More
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
To learn React, check out the [React documentation](https://reactjs.org/).