Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/uptechteam/fe-vitejs-template


https://github.com/uptechteam/fe-vitejs-template

Last synced: 4 days ago
JSON representation

Awesome Lists containing this project

README

        

# ViteJS React TypeScript Template

## Introduction

This template uses all the fastest utils/builder to provide the most efficient linting / testing / building process.
This template also uses NodeJS v20+ (latest LTS), that contains all the latest security and performance improvements.

## Installation

Install pnpm if not installed yet:
```bash
npm i -g pnpm
```

Install dependencies:
```bash
pnpm i
```

## Running locally

```bash
pnpm dev
```

## Audit
Pnpm uses its own packages' versions override system. To run audit just run:
```bash
pnpm audit
```

## Updating dependencies
```bash
pnpm i -g npm-check-updates
ncu -u --target minor
pnpm i
```

## Template's core:
* [NodeJS 20](https://nodejs.org/en/)
* [pnpm](https://pnpm.io/)
* [ViteJS](https://vitejs.dev/)

## Production bundle includes:

* [ReactJS 18](https://reactjs.org/)
* Material UI

## Development dependencies:

* [TypeScript](https://www.typescriptlang.org/)
* [ESLint](https://eslint.org/) + [Prettier](https://prettier.io/)
* [Husky](https://www.npmjs.com/package/husky) + hooks:
* pre-commit: lint and test
* commit-msg: conventional commit message
* [CommitLint](https://www.conventionalcommits.org/en/v1.0.0/)