https://github.com/ederssouza/react-typescript-boilerplate

A React Boilerplate with TypeScript for SPA projects
https://github.com/ederssouza/react-typescript-boilerplate

editorconfig eslint jest plop prettier react react-testing-library reactjs typescript

Last synced: about 12 hours ago
JSON representation

A React Boilerplate with TypeScript for SPA projects

• Host: GitHub
• URL: https://github.com/ederssouza/react-typescript-boilerplate
• Owner: ederssouza
• Created: 2022-09-14T19:00:36.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-12T22:39:47.000Z (about 2 months ago)
• Last Synced: 2024-09-13T11:55:00.017Z (about 2 months ago)
• Topics: editorconfig, eslint, jest, plop, prettier, react, react-testing-library, reactjs, typescript
• Language: JavaScript
• Homepage:
• Size: 2.28 MB
• Stars: 14
• Watchers: 3
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# React TypeScript Boilerplate

## What is inside?

- [Vite](https://vitejs.dev)

- [EditorConfig](https://editorconfig.org)

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

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

- [Jest](https://jestjs.io)

- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)

- [Plop js](https://plopjs.com)

## Getting Started

First, run the development server:

```bash

npm run dev

# or

yarn dev

```

Open [http://localhost:5173](http://localhost:5173) with your browser to see the result.

## Scripts

- `dev`: starts the application in development mode;

- `build`: creates the production version;

- `preview`: initializes a local static web server that serves files from the `dist` directory (this is an easy way to verify that the production build is working correctly);

- `lint`: runs linter on all files that are in the configuration rule;

- `lint:fix`: runs linter and fixes all files that are in the configuration rule;

- `typecheck`: checks if the file types are correct;

- `test`: runs unit and integration tests;

- `test:watch`: runs unit and integration tests in listening mode;

- `coverage-test`: runs unit and integration tests and generates a code coverage report;

- `coverage-test:watch`: runs unit and integration tests and generates a code coverage report in listen mode;

- `generate:component`: creates basic structure of a component;

- `generate:hook`: creates the basic structure of a hook.