react-typescript-yarn-lerna-monorepo-eslint-prettier-boilerplate - GitLite

KO | EN

gitlite — search

#hacktoberfest #react #golang #android #machine-learning #macos #nodejs #java #windows #awesome #awesome-list #pytorch #ios #open-source

react-typescript-yarn-lerna-monorepo-eslint-prettier-boilerplate

(★ 55)

Starting point for a Typescript, React (v16.8.0-alpha.0), Yarn & Lerna monorepo project with full setup for ESLint and Prettier.

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- pull_request_template.md
- - .eslintrc.json
  - package.json
  - tsconfig.json
- - .eslintrc.json
  - package.json
  - README.md
  - tsconfig.json
- - .eslintrc.json
  - package.json
  - README.md
  - tsconfig.json
.eslintignore
.eslintrc.json
.gitignore
.prettierrc
CODE_OF_CONDUCT.md
CONTRIBUTING.md
lerna.json
LICENSE
package.json
README.md
tsconfig.json
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/michielbouw/react-typescript-yarn-lerna-monorepo-eslint-prettier-boilerplate

Downloads the entire project code from GitHub to your computer.

cd react-typescript-yarn-lerna-monorepo-eslint-prettier-boilerplate

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

curl -L https://github.com/michielbouw/react-typescript-yarn-lerna-monorepo-eslint-prettier-boilerplate/archive/master.zip | tar zx

Type this command into your terminal and run it.

git clone git@github.com:michielbouw/react-typescript-yarn-lerna-monorepo-eslint-prettier-boilerplate.git APP_NAME

Downloads the entire project code from GitHub to your computer.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# React (v16.8.0+), Typescript, Yarn & Lerna Monorepo

Starting point for a Typescript, React (v16.8.0+, *tested up to v16.13.1*), Yarn & Lerna monorepo project with full setup for ESLint and Prettier.

## Stack

This project is initialized with [Create React App](https://github.com/facebook/create-react-app) consisting of:

- TypeScript
- React (v16.8.0+, *tested up to v16.13.1*)
- react-scripts (react-scripts v3+, *tested up to v3.4.0*, from createReactApp)
- react-testing-library (not Enzyme)
- Yarn Workspaces (multiple packages architecture)
- Lerna (tool for managing the monorepo packages)
- SASS/SCSS
- ESLint (instead of deprecated TSLint)
- Prettier

### Content

The project now consists of 3 packages.

- **www**: create-react-app with TypeScript (react v16.13.1+, react-scripts v3.4.0)
- **shared**: react components with TypeScript (react v16.13.1+)
- **utils**: shared functions with TypeScript

## Get Started

### Make sure you run Node.js v10.15+

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-yarn-lerna-monorepo-eslint-prettier-boilerplate/archive/master.zip | tar zx
mv react-typescript-eslint-prettier-boilerplate APP_NAME
cd APP_NAME
```

or

```bash
git clone git@github.com:michielbouw/react-typescript-yarn-lerna-monorepo-eslint-prettier-boilerplate.git APP_NAME
cd APP_NAME
```

### `yarn install`

Note: this project is initialized with Yarn.

### Adding / removing packages

To add a new package create a new folder in under `packages` and copy the<br>
`.eslint.json`, `package.json`, `tsconfig.json` from another similar project in here.<br>
After that you can setup your project how you like it.

(you can also extend the custom scripts from the main `package.json`<br>
or already include in as dependency for another package).

After changing the packages run `yarn clean:update` to clean & reinit the workspaces.

After changing the external libraries or peerDependencies it is good to clean the repo<br>
by removing the node_modules folder `rm -rf node_modules` and reinstalling `yarn install`.
And after that run `yarn clean:update` to clean & reinit the workspaces.

## Development Scripts

In the project directory, you can run:

### `yarn start`

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.<br>
You will also see any lint errors in the console.

### `yarn typecheck`

Launches the typescript check for code to check for TypeScript compilation errors or warnings.

### `yarn lint`

Launches the linter for code to check for code layout errors or warnings.

### `yarn 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`

Launches the test runner in the interactive watch mode.<br>
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

## Production Scripts

### `yarn build`

Builds the app for production to the build folder.<br>
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.<br>
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/).