Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jvidalv/vital
Starter template for Vite with React (TypeScript). Supports Tailwind. Vitest and @react/testing-library configured and ready to go. Also ESLint, Prettier, Husky, Commit-lint and Atomic Design for components.
https://github.com/jvidalv/vital
eslint husky postcss prettier react starter tailwindcss template typescript vite vitest
Last synced: about 1 month ago
JSON representation
Starter template for Vite with React (TypeScript). Supports Tailwind. Vitest and @react/testing-library configured and ready to go. Also ESLint, Prettier, Husky, Commit-lint and Atomic Design for components.
- Host: GitHub
- URL: https://github.com/jvidalv/vital
- Owner: jvidalv
- License: mit
- Created: 2021-10-23T14:17:34.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-25T18:06:57.000Z (12 months ago)
- Last Synced: 2024-01-26T10:09:51.326Z (8 months ago)
- Topics: eslint, husky, postcss, prettier, react, starter, tailwindcss, template, typescript, vite, vitest
- Language: TypeScript
- Homepage: https://vital.josepvidal.dev
- Size: 274 KB
- Stars: 225
- Watchers: 5
- Forks: 34
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Mocking up web app with Vital(speed)
## Features
- ⚡️ [React 18](https://beta.reactjs.org/)
- 🦾 TypeScript, of course
- 🫀 [Vitest](https://vitest.dev/) - unitary testing made easy
- 🎨 [Tailwind with JIT](https://tailwindcss.com/) - next generation utility-first CSS
- 👑 [Atomic Design organization](https://bradfrost.com/blog/post/atomic-web-design/)
- 🗂 [Absolute imports](https://github.com/vitejs/vite/issues/88#issuecomment-762415200)
- 😃 [Hero icons](https://heroicons.com/)
- ☁️ Deploy on Netlify, zero-config
### Coding Style
- [ESLint](https://eslint.org/) - configured for React/Hooks & TypeScript
- [Prettier](https://prettier.io/)
### Dev tools
- [TypeScript](https://www.typescriptlang.org/)
- [Commit lint](https://github.com/conventional-changelog/commitlint) - helps your team adhering to a commit convention
- [Netlify](https://www.netlify.com/) - zero-config deployment
## Try it now!
### GitHub Template
[Create a repo from this template on GitHub](https://github.com/jvidalv/vital/generate).
### Clone to local
If you prefer to do it manually with the cleaner git history
```bash
npx degit jvidalv/vital my-vital-app
cd my-vital-app
yarn # If you don't have yarn installed, run: npm install -g yarn
```
## Checklist
When you use this template, try follow the checklist to update your info properly
- [ ] Rename `name` and `author` fields in `package.json`
- [ ] Change the author name in `LICENSE`
- [ ] Change the title in `index.html`
- [ ] Change the favicon in `public`
- [ ] Modify the manifest in `public`
- [ ] Clean up the README's
And, enjoy :)
## Usage
### Development
Just run and visit http://127.0.0.1:3000/
```bash
yarn dev
```
### Build
To build the App, run
```bash
yarn build
```
And you will see the generated file in `dist` that ready to be served.
### Deploy on Netlify
Go to [Netlify](https://app.netlify.com/start) and select your repository, `OK` along the way, and your App will be live in a minute.
### Issues
#### Husky
If pre-commit hooks are not working be sure that you have installed husky: `husky install`.
By default this command should be triggered after yarn/npm deps are installed.
## Why
I have created several React apps recently. Setting the configs up is kinda the bottleneck for me to make the ideas simply come true within a very short time.
So I made this starter template for myself to create apps more easily, along with some good practices that I have learned from making those apps. Feel free to tweak it or even maintains your own forks.