https://github.com/m-avagyan/webpack-react-typescript-template

Modern template to start creating react app using webpack and typescript 🚀
https://github.com/m-avagyan/webpack-react-typescript-template

commitlint eslint husky i18next jest prettier react react-router-v6 react-testing-library react-typescript-boilerplate react-typescript-starter react-typescript-webpack styled-components typescript unit-testing webpack webpack-react

Last synced: about 2 months ago
JSON representation

Modern template to start creating react app using webpack and typescript 🚀

• Host: GitHub
• URL: https://github.com/m-avagyan/webpack-react-typescript-template
• Owner: m-avagyan
• License: mit
• Created: 2022-10-10T11:36:48.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-03-26T12:39:52.000Z (9 months ago)
• Last Synced: 2024-03-26T13:46:48.807Z (9 months ago)
• Topics: commitlint, eslint, husky, i18next, jest, prettier, react, react-router-v6, react-testing-library, react-typescript-boilerplate, react-typescript-starter, react-typescript-webpack, styled-components, typescript, unit-testing, webpack, webpack-react
• Language: TypeScript
• Homepage: https://martikavagyan.com
• Size: 296 KB
• Stars: 9
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# webpack-react-typescript

Modern template to start creating react app using webpack and typescript 🚀

## Getting Started

Installing

-   `git clone https://github.com/m-avagyan/webpack-react-typescript-template.git`

-   `cd webpack-react-typescript-template`

-   `yarn install --frozen-lockfile`

Run Locally

-   `yarn dev` - server started at [localhost:3000](https://localhost:3000/) in local mode

-   `yarn start` - server started at [localhost:3000](https://localhost:3000/) in development mode

-   `yarn watch` - server started at [localhost:3000](https://localhost:3000/) in production mode

Build Project

-   `yarn clean` - clean the `dist/` directory

-   `yarn build` - we can see the output in `dist/` directory

Run Unit Tests

-   `yarn test` - run all test cases

-   `yarn test:watch` - run all test cases in watch mode

-   `yarn test:coverage` - run all test cases and collect coverage for each tested files

Analyze

-   `yarn analyze` - build project to `/dist` and analyze your bundle size in [localhost:3006](http://localhost:3006)

Codebase

-   `yarn lint` - lint the codebase

-   `yarn format` - format the codebase using prettier

### Tools and Technologies

-   [ReactJS](https://reactjs.org/)

-   [React Router](https://reactrouter.com/en/main/)

-   [TypeScript](https://www.typescriptlang.org/)

-   [Webpack](https://webpack.js.org/)

-   [Styled Components](https://styled-components.com/)

-   [i18next](https://react.i18next.com/)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## Commits

-   We use the [conventional commit lint](https://commitlint.js.org/#/) for linting our commit messages

-   Also before every commit we run the `lint` command using [husky](https://typicode.github.io/husky/#/) for lint our

    codebase

---

## Author

**Martik Avagyan**

-   Website: [martikavagyan.com](https://martikavagyan.com)

-   Twitter: [@martikavagyan](https://twitter.com/martikavagyan)

-   GitHub: [@m-avagyan](https://github.com/m-avagyan)

---

## License

[MIT](https://choosealicense.com/licenses/mit/)