https://github.com/tessmore/react-ts-minimal-template

Create a minimal React app that makes use of TypeScript, Vite, Prettier et cetera.
https://github.com/tessmore/react-ts-minimal-template

Last synced: 21 days ago
JSON representation

Create a minimal React app that makes use of TypeScript, Vite, Prettier et cetera.

• Host: GitHub
• URL: https://github.com/tessmore/react-ts-minimal-template
• Owner: Tessmore
• License: mit
• Created: 2024-08-05T16:16:23.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-14T18:38:11.000Z (4 months ago)
• Last Synced: 2024-08-14T20:17:03.916Z (4 months ago)
• Language: TypeScript
• Homepage: https://tessmore.github.io/react-ts-minimal-template/
• Size: 568 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# PLACEHOLDER_TITLE

Create a minimal React app that makes use of TypeScript, Vite, Prettier et cetera.

## Usage

```bash

git clone --depth 1 [email protected]:Tessmore/react-ts-minimal-template my-app

cd my-app

# Start your own history

rm -rf .git

git init

git branch -M main

yarn install

yarn dev

```

## Available commands

Run in development mode

```bash

  yarn dev

```

Create production build

```bash

  yarn build

```

Run ESLint linting

```bash

  yarn lint

```

Run Prettier formatting

```bash

  yarn format

```

Deploy using GitHub pages

```bash

  yarn run deploy

```

Set app title

```

git ls-files | xargs sed -i 's/PLACEHOLDER_TITLE/TITLE/g'

```

Set app author

```

git ls-files | xargs sed -i 's/PLACEHOLDER_AUTHOR/AUTHOR/g'

```

Change `` references

```

git ls-files | xargs sed -i 's/react-ts-minimal-template/YOUR_REPOSITORY/g'

```

## Publish code

Once you cloned this repository and made the repository yours, you can host it yourself:

```

git commit -am "Initial commit"

```

- Create new repository (but do *not* initialize it with a README, .gitignore, or license)

```

git remote add origin [email protected]:/.git

# Alternatively, update the remote

git remote set-url origin [email protected]:/.git

```

- Push your changes

```

git push -u origin main

```

## Resources

A minimal Vite + React + TypeScript template with pre-configured ESLint (with Airbnb JS/React rules), Prettier and Git hooks powered by Husky out of the box 📦, based on https://github.com/alessandropisu/vite-react-ts-minimal-template

![Vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E)

![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)

![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)

![ESLint](https://img.shields.io/badge/eslint-3A33D1?style=for-the-badge&logo=eslint&logoColor=white)

![Prettier](https://img.shields.io/badge/prettier-1A2C34?style=for-the-badge&logo=prettier&logoColor=F7BA3E)

## License

[MIT](https://choosealicense.com/licenses/mit/)