React TypeScript Starter

Read more about why and list of all supported features here

To Start

Click Use this template button above or click here 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 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

Semantic Release - Setup

Renovate Github App Installation

How tos

How to import and use SVG?

import Check from '../../../assets/check.svg'; // import
<Check /> // use

Questions or Ideas?

Please start a new discussion