Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xieqin/react-ts-template

React TypeScript template with Vite using React-Router-V6 & Zustand & Mobx; PWA support
https://github.com/xieqin/react-ts-template

pwa-example react-router-v6 reactjs vite zustand

Last synced: about 2 months ago
JSON representation

React TypeScript template with Vite using React-Router-V6 & Zustand & Mobx; PWA support

Host: GitHub
URL: https://github.com/xieqin/react-ts-template
Owner: xieQin
License: mit
Created: 2023-02-05T04:12:43.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-03-12T15:21:10.000Z (almost 2 years ago)
Last Synced: 2024-10-15T00:26:53.984Z (3 months ago)
Topics: pwa-example, react-router-v6, reactjs, vite, zustand
Language: TypeScript
Homepage: https://react-ts-template-liart.vercel.app
Size: 596 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # React TypeScript template with Vite & PWA support

[![react](https://img.shields.io/github/package-json/dependency-version/xieQin/react-ts-template/react)](https://github.com/facebook/react) ![react-router-dom](https://img.shields.io/github/package-json/dependency-version/xieQin/react-ts-template/react-router-dom) [![zustand](https://img.shields.io/github/package-json/dependency-version/xieQin/react-ts-template/zustand)](https://github.com/pmndrs/zustand) [![mobx](https://img.shields.io/github/package-json/dependency-version/xieQin/react-ts-template/mobx)](https://mobx.js.org) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/xieQin/react-ts-template/blob/main/LICENSE.md)

This is a [React](https://reactjs.org) + [TypeScript](https://www.typescriptlang.org/) boilerplate built with [Vite](https://vitejs.dev) using [React-Router](https://reactrouter.com) & [Zustand](https://zustand-demo.pmnd.rs).

## What's inside?

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

- [React-Router](https://reactrouter.com)

- [Zustand](https://zustand-demo.pmnd.rs)

- [Mobx](https://mobx.js.org)

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

- [TypeScript](https://www.typescriptlang.org)

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

- [Testing Library](https://testing-library.com)

- [Cypress](https://www.cypress.io)

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

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

- [Polyfills](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy#readme)

## Getting started

1. Create the project.

   ```bash

   git clone https://github.com/xieQin/react-ts-template my-app

   ```

2. Access the project directory.

   ```bash

   cd my-app

   ```

3. Initialize a git repository.

   ```bash

   git init

   ```

4. Install dependencies.

   ```bash

   npm install

   ```

5. Start dev server with hot reload at http://localhost:3000.

   ```bash

   npm run dev

   ```

## Recommended VS Code extensions

- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)

- [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)

## Other commands

### Lint commands

```bash

npm run lint

```

### Build commands

```bash

npm run build

```

### Run the app in production mode at http://localhost:3000.

```bash

npm run serve

```

### Test commands

- Run unit tests and watch

  ```bash

  npm run test:unit

  ```

- Run unit tests with coverage

  ```bash

  npm run test:unit:coverage

  ```

- Run e2e tests

  ```bash

  npm run test:e2e

  ```

## License

This project is licensed under the MIT License.