https://github.com/amirzenoozi/react-typescript-webpack-starter

Simple Starter Project For React + Typescript Without CRA
https://github.com/amirzenoozi/react-typescript-webpack-starter

cli create-react-app create-react-app-typescript environment husky material-ui react scp styled-components typescript webpack

Last synced: 7 days ago
JSON representation

Simple Starter Project For React + Typescript Without CRA

• Host: GitHub
• URL: https://github.com/amirzenoozi/react-typescript-webpack-starter
• Owner: amirzenoozi
• Created: 2021-08-25T07:29:17.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-10-09T20:55:13.000Z (over 3 years ago)
• Last Synced: 2024-11-20T11:13:14.357Z (2 months ago)
• Topics: cli, create-react-app, create-react-app-typescript, environment, husky, material-ui, react, scp, styled-components, typescript, webpack
• Language: TypeScript
• Homepage:
• Size: 1.13 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        
# ⚛ React Starter With Typescript & Material-UI

Front-end starter kit:

- [x] Webpack as module bundler

- [X] Typescript

- [x] Material-UI

- [X] MultiLang Support With I18next

- [X] Styled Component Support

- [X] BrowserSync

- [X] SpriteSvg Module NPM Task

- [X] Redux As StateManager

- [X] SCP Module To Move Your Build

- [X] GoogleApi As TsLint

- [X] Custom RegEx for Filenames as Linter Rule

- [X] Jest As Test Module

- [X] Husky For PreCommits Rules

## ❓ Usage

Minimum node version: 14

After Clone This Repo You Can Start it By Running `yarn start` after that you have access to the UI application on `http:localhost:4001/`

## 🛡 Environment Variables

You Can Have Your Env Variable By Using the `environments` folder and put your own `dev` and `prod` environments in different files. to read more about this type of environments variable structure you can read [This](https://amirzenoozi.medium.com/how-to-have-angular-environment-structure-in-react-applications-without-cra-e970443e9068).

## 😎 Use CLI

In This Starter We Put A simple Cli That You Change the template from `cli` folder. if you want to create component by this cli you just need to run `yarn run component component-name` and you will see the magic

## 🏗 Build

Run `yarn run build` to build the project. The build artifacts will be stored in the `build/` directory.

## 🧪 Running unit tests

Run `yarn run jest-test` to execute the unit tests via [Jest](https://jestjs.io/). \

and also Run `yarn run jest-test:watch` and check you test on development mode.

## 👼 Running Linter

Run `yarn run lint` to check the linter rules via [esLint](https://eslint.org/).