https://github.com/bhirmbani/typescript-react

A minimal best practice starter for react project using typescript. Eslint for code standard, prettier for formatting, babel for converting typescript to regular JS, webpack for bundling and build it to static html.
https://github.com/bhirmbani/typescript-react

babeljs boiler eslint prettier react webpack

Last synced: about 1 month ago
JSON representation

A minimal best practice starter for react project using typescript. Eslint for code standard, prettier for formatting, babel for converting typescript to regular JS, webpack for bundling and build it to static html.

• Host: GitHub
• URL: https://github.com/bhirmbani/typescript-react
• Owner: bhirmbani
• Created: 2019-05-05T01:24:52.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-03T21:04:42.000Z (almost 2 years ago)
• Last Synced: 2024-09-29T06:21:45.884Z (about 2 months ago)
• Topics: babeljs, boiler, eslint, prettier, react, webpack
• Language: JavaScript
• Homepage:
• Size: 1.86 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 18
• Metadata Files:
  • Readme: readme.MD

Awesome Lists containing this project

README

        


  


  React-Typescript

  


  




A minimal best practice starter for react project using typescript.




  Key Features •

  How To Use •

  Credits •

  License



## Key Features

-   Typescript

    -   Build React app using typescript so your team can maximise static type typing

-   Eslint - Enforce code standard for your team using eslint instead of tslint for better performance [1](#f1)

-   Prettier

    -   Integrate prettier with eslint to automatically fix code standard and format

-   Built for use with visual studio code ✨

    -   Using Eslint [2](#f2) and Prettier [3](#f3) extensions so you can have the best development workflow

    -   But also have NPM script so it can also works for the prefered IDE's of yours..

-   More to follow..

## How To Use

To clone and run this application, you'll need [Git](https://git-scm.com) and [Node.js](https://nodejs.org/en/download/) (which comes with [npm](http://npmjs.com)) installed on your computer. From your command line:

```bash

# Clone this repository

$ git clone https://github.com/bhirmbani/typescript-react.git

# Go into the repository

$ cd typescript-react

# Install dependencies

$ npm install

# Run in development

$ npm run dev

```

Note: If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt.

## Credits

This boilerplate uses the following open source packages:

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

-   [Typescript](https://typescriptlang.org)

-   [Eslint](https://eslint.org/)

-   [Babel](https://babeljs.io/)

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

-   [Prettier](https://prettier.io/)

## Footnotes

1 [Typescript 2019 roadmap](https://github.com/Microsoft/TypeScript/issues/29288) [↩](#ts-roadmap)

2 [Eslint Vscode extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) [↩](#eslint)

3 [Eslint Vscode extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) [↩](#prettier)

## License

MIT

---

> GitHub [@bhirmbani](https://github.com/bhirmbani)  ·