https://github.com/hhimanshu/react-ts-starter

A React TypeScript Project with baked-in development to production lifecycle
https://github.com/hhimanshu/react-ts-starter

eslint github-actions jest pretter react react-router react-router-dom react-testing-library renovate storybook typescript vercel webpack

Last synced: 3 months ago
JSON representation

A React TypeScript Project with baked-in development to production lifecycle

• Host: GitHub
• URL: https://github.com/hhimanshu/react-ts-starter
• Owner: hhimanshu
• License: mit
• Created: 2021-02-18T21:11:25.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-27T22:49:00.000Z (3 months ago)
• Last Synced: 2024-09-28T22:20:53.243Z (3 months ago)
• Topics: eslint, github-actions, jest, pretter, react, react-router, react-router-dom, react-testing-library, renovate, storybook, typescript, vercel, webpack
• Language: TypeScript
• Homepage: https://react-ts-starter-hhimanshu.vercel.app
• Size: 33.5 MB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# React TypeScript Starter

Read more about why and list of all supported features [here](https://react-ts-starter-hhimanshu.vercel.app/)

## To Start

Click **Use this template** button above or [click here](https://github.com/hhimanshu/create-react-ts-starter/generate) to create a new repository based on this template.

You need to provide the name of this project. Once Github creates the project, you must [clone the repo](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository) to your local before you start executing the commands

## Commands

- `./setup.sh` to install dependencies.

- `yarn start` to develop locally.

- `yarn test` to test and see the code coverage.

- `yarn test:watch` to test in the watch mode.

- `yarn build` to create a production build.

- `yarn lint` to lint your code using `eslint`.

- `yarn start-prod` to serve production build on port `5000`.

- `yarn storybook` to start storybook in development mode.

- `yarn build-storybook` to create production build for storybook.

- `yarn start-prod-storybook` to serve production build for storybook on port `5858`.

## 3rd party setup

If you are planning to leverage the ecosystem as available in this repository, you need to setup your project to use

Vercel, Semantic Release and Renovate.

All these tools are easy to configure. Please find their documentation below

[Vercel - Deploy a project](https://vercel.com/docs#deploy-an-existing-project)

[Semantic Release - Setup](https://semantic-release.gitbook.io/semantic-release/usage/getting-started)

[Renovate Github App Installation](https://docs.renovatebot.com/install-github-app/)

## How tos

### How to import and use `SVG`?

```tsx

import Check from '../../../assets/check.svg'; // import

 // use

```

## Questions or Ideas?

Please [start a new discussion](https://github.com/hhimanshu/create-react-ts-starter/discussions)