https://github.com/benhunter/typescript-react-eslint-starter
Typescript React ESLint (Airbnb style) with Create React App
https://github.com/benhunter/typescript-react-eslint-starter
Last synced: 8 months ago
JSON representation
Typescript React ESLint (Airbnb style) with Create React App
- Host: GitHub
- URL: https://github.com/benhunter/typescript-react-eslint-starter
- Owner: benhunter
- Created: 2022-02-13T22:45:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-03-01T22:30:44.000Z (over 4 years ago)
- Last Synced: 2025-04-02T21:44:17.162Z (about 1 year ago)
- Language: JavaScript
- Size: 358 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Frontend Starter App
- Create React App
- Typescript
- ESLint with Airbnb style guide
- Cypress and Cypress Testing Library
## How I set up the Starter
```shell
yarn create react-app typescript-react-eslint-starter --template typescript
cd typescript-react-eslint-starter
yarn add eslint --dev
yarn create @eslint/config
```
For ESLint config select:
- How would you like to use ESLint?
- To check syntax, find problems, and enforce code style
- What type of modules does your project use?
- JavaScript modules (import/export)
- Which framework does your project use?
- React
- Does your project use TypeScript?
- Yes
- Where does your code run?
- Browser
- How would you like to define a style for your project?
- Use a popular style guide
- Which style guide do you want to follow?
- Airbnb: https://github.com/airbnb/javascript
- What format do you want your config file to be in?
- JSON
```shell
npx eslint src/*
npx eslint src/* --fix
npx eslint src/* --quiet # ignore warnings
yarn add --dev eslint-import-resolver-typescript
yarn add --dev cypress
yarn add --dev @testing-library/cypress
yarn journey
```
## ESLint Config
Helpful article: [Setting ESLint on a React Typescript project](https://andrebnassis.medium.com/setting-eslint-on-a-react-typescript-project-2021-1190a43ffba)
The article is slightly outdated. I didn't have to fix all the errors listed in the article.
# Getting Started with Create React App
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.
## 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/).