Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fdaciuk/boilerplate-vite-react
Create a new project with React.js, TypeScript and jest with Vite
https://github.com/fdaciuk/boilerplate-vite-react
eslint husky react reactjs typescript vite
Last synced: about 2 months ago
JSON representation
Create a new project with React.js, TypeScript and jest with Vite
- Host: GitHub
- URL: https://github.com/fdaciuk/boilerplate-vite-react
- Owner: fdaciuk
- Created: 2022-01-19T11:17:56.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-29T01:20:11.000Z (over 1 year ago)
- Last Synced: 2024-10-13T13:31:39.396Z (2 months ago)
- Topics: eslint, husky, react, reactjs, typescript, vite
- Language: TypeScript
- Homepage:
- Size: 236 KB
- Stars: 103
- Watchers: 5
- Forks: 39
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Boilerplate React.js + TypeScript + Vite 👋
[](#contributors-)
> Boilerplate to create React.js apps with Vite
## Which techs this boilerplate have in it?
This boilerplate is ready to be used by devs who want to start a new project using React.js, TypeScript and Jest with Vite.
## Main configurations
- React.js 18+ with TypeScript;
- You can import "svgs" with `import { ReactComponent as MyIcon } from './icon-path.svg'`;
- You can import any other media (images, videos, etc) that is located inside `src` directory;
- You can use absolute imports, using `@` as `src` directory;
- Eslint:
- [Standard](https://standardjs.com/) with some modifications;
- React Hooks and other React configurations with [eslint-config-react-app](https://www.npmjs.com/package/eslint-config-react-app) (same used in Create React App);
- Automatic lint and type-checking with Husky before every commit.
## Usage
Install the dependencies:
```sh
yarn install
```
Run dev server:
```sh
yarn dev
```
You can run type-checking in watch mode in another terminal, if you may:
```sh
yarn type-check --watch
```
## Run tests
```sh
yarn test
```
## Production version
To generate the production version, you can run:
```sh
yarn build
```
All files you have to deploy will be located at the `dist` directory.
### Run production version locally
To check if everything will be ok in production before the deployment, you can run this command after `yarn build`:
```sh
yarn preview
```
## Author
👤 **Fernando Daciuk**
* Website: https://daciuk.dev
* Twitter: [@fdaciuk](https://twitter.com/fdaciuk)
* Github: [@fdaciuk](https://github.com/fdaciuk)
* LinkedIn: [@fdaciuk](https://linkedin.com/in/fdaciuk)
* Instagram : [@fdaciuk](https://instagram.com/fdaciuk)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/fdaciuk/boilerplate-vite-react/issues).
## ✨ Contributors
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Fernando Daciuk
💻 📖
Gabriel Pinheiro
💻
NewCapital.in
💻
Vinícius Bispo
💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
## Show your support
Give a ⭐️ if this project helped you!
***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_