https://github.com/saranshkataria/frontend-starter-toolkit

Setting up a react project using Typescript
https://github.com/saranshkataria/frontend-starter-toolkit

javascript react reactjs typescript webpack

Last synced: 19 days ago
JSON representation

Setting up a react project using Typescript

• Host: GitHub
• URL: https://github.com/saranshkataria/frontend-starter-toolkit
• Owner: saranshkataria
• License: mit
• Created: 2019-02-09T00:25:46.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T13:31:52.000Z (almost 2 years ago)
• Last Synced: 2024-04-29T18:11:25.226Z (7 months ago)
• Topics: javascript, react, reactjs, typescript, webpack
• Language: JavaScript
• Homepage:
• Size: 1.09 MB
• Stars: 24
• Watchers: 3
• Forks: 4
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Frontend Starter Toolkit

This starter toolkit is a good starting place for you if you are starting out with a React based project using Typescript. You can clone this repository and start using the project without having to worry about configuring tools and configurations.

This project uses React, Typescript, Babel (for transpiling TS), Webpack ,ESLint (for code checking), Prettier (for code formatting) and Jest (for testing).

If you are interested in learning about the configurations, then this project can be useful as well since all the configurations have been outlined as individual commits in the history of the project to make it easier to understand. We have also started writing posts explaining the configuration steps. You can read about the following posts:

- [Configuring Typescript with Babel and Webpack](https://www.wisdomgeek.com/development/web-development/how-to-setup-typescript-with-babel-and-webpack/)

- [Setting up ESLint for TypeScript](https://www.wisdomgeek.com/development/web-development/how-to-setup-eslint-for-typescript-code/)

- [How to setup Jest in a TypeScript, Babel and Webpack project](https://www.wisdomgeek.com/development/web-development/how-to-setup-jest-typescript-babel-webpack-project)

More posts will follow soon.

## Running the project

**You’ll need to have Node installed on your local development machine**. You can then clone this repo

```sh

git clone --depth=1 https://github.com/saranshkataria/frontend-starter-toolkit.git 

```

You can then start building your own project based on the project that gets cloned. You can also remove the remote to the repo to avoid accidentally pushing to it.

Once you have a copy of the project, you need to install the dependencies. Run the command `npm install` or `yarn` in the command line.

After that you can run one of the following commands in the command line:

- `npm dev` or `yarn dev` to run a development server using webpack dev server. Each time you hit save, changes get hot reloaded using hot module replacement

- `npm prod` or `yarn prod` to create a production build

- `npm prod:debug` or `yarn prod:debug` to run webpack in debug mode while using the production configuration

- `npm dev:debug` or `yarn dev:debug` to run webpack in debug mode while using the development configuration

- `npm lint` or `yarn lint` for running ESLint to type check your source code

- `npm test` or `yarn test` for running Jest to run your test cases

It is also recommended that you install the Prettier extension for your IDE/Editor since the project supports it out of the box. Prettier has also been integrated as a pre commit hook to ensure that all files are formatted correctly. If you are not sure about what prettier is, you can read more about it [in this blog post about Prettier](https://www.wisdomgeek.com/development/web-development/using-prettier-format-javascript-code/).