Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wtchnm/vitamin
Opinionated Vite starter template.
https://github.com/wtchnm/vitamin
cypress e2e eslint jest prettier react tailwindcss typescript vite vitest
Last synced: about 1 month ago
JSON representation
Opinionated Vite starter template.
- Host: GitHub
- URL: https://github.com/wtchnm/vitamin
- Owner: wtchnm
- License: mit
- Created: 2021-02-08T19:18:44.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T02:28:39.000Z (3 months ago)
- Last Synced: 2024-10-13T06:41:15.699Z (about 1 month ago)
- Topics: cypress, e2e, eslint, jest, prettier, react, tailwindcss, typescript, vite, vitest
- Language: TypeScript
- Homepage: https://vitamin-wtchnm.vercel.app/
- Size: 5.7 MB
- Stars: 547
- Watchers: 4
- Forks: 48
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Vitamin
[](https://codecov.io/gh/wtchnm/Vitamin)   [](https://dashboard.cypress.io/projects/etow1b/runs) [](https://github.com/prettier/prettier) [](http://commitizen.github.io/cz-cli/) [](https://github.com/wtchnm/Vitamin/blob/main/LICENSE)
> [!WARNING]
> Project in maintenance mode.
Opinionated Vite starter template.
## Features
- [Vite](https://vitejs.dev) with [React](https://reactjs.org), [TypeScript](https://www.typescriptlang.org) and [absolute imports](https://github.com/aleclarson/vite-tsconfig-paths).
- [Tailwind CSS v3](https://tailwindcss.com) with a [basic reset for form styles](https://github.com/tailwindlabs/tailwindcss-forms) and a [Prettier plugin](https://github.com/tailwindlabs/prettier-plugin-tailwindcss) that automatically sorts classes.
- Use [ESLint](https://eslint.org), [stylelint](https://stylelint.io) and [Prettier](https://prettier.io) on VSCode and before you commit with [Husky](https://github.com/typicode/husky) and [lint-staged](https://github.com/okonet/lint-staged).
- [PWA](https://github.com/antfu/vite-plugin-pwa) with [17/17 Lighthouse score](https://web.dev/pwa-checklist/).
- Write unit and integration tests with [Vitest](https://vitest.dev/) and [Testing Library](https://testing-library.com/).
- Write e2e tests with [Cypress](https://www.cypress.io).
- GitHub Actions for automatic [dependency updates](https://renovatebot.com/), [CodeQL Analysis](https://securitylab.github.com/tools/codeql), running tests and code coverage with [Codecov](https://about.codecov.io/).
- Deploy to [vercel.com](https://vercel.com/) with pre-configured [SPA fallback](https://vercel.com/docs/configuration#routes/advanced/spa-fallback).
## Getting started
Use this repository as a [GitHub template](https://github.com/wtchnm/Vitamin/generate) or use [degit](https://github.com/Rich-Harris/degit) to clone to your machine with an empty git history:
```
npx degit wtchnm/Vitamin#main my-app
```
Then, install the dependencies:
```
pnpm install
```
### Before you start coding
- [ ] If you don't plan to use GitHub Actions, delete the `.github` directory.
- [ ] Clean up the `cypress/e2e/index.spec.ts` file.
- [ ] Change the `favicon.png`, `apple-touch-icon.png`, `android-chrome-192x192.png` and `android-chrome-512x512.png`. [favicon.io](https://favicon.io) is a cool tool for generating these assets.
- [ ] In the `src` folder, remove the `__tests__`, `api` and `components` folder and the `types.ts` file.
- [ ] If you don't plan to use `react-query`, remove the query client logic in the `main.tsx` file.
- [ ] Change the title, description and theme color in the `index.html` and `vite.config.ts`. The [Inter](https://rsms.me/inter/) font is included, so remove it if you want.
- [ ] Modify or delete the `LICENSE` file.
- [ ] Change the `name` field in package.json.
## Scripts
- `pnpm dev` - start a development server with hot reload.
- `pnpm build` - build for production. The generated files will be on the `dist` folder.
- `pnpm preview` - locally preview the production build.
- `pnpm test` - run unit and integration tests related to changed files based on git.
- `pnpm test:ci` - run all unit and integration tests in CI mode.
- `pnpm test:e2e` - run all e2e tests with the Cypress Test Runner.
- `pnpm test:e2e:headless` - run all e2e tests headlessly.
- `pnpm format` - format all files with Prettier.
- `pnpm lint` - runs TypeScript, ESLint and Stylelint.
- `pnpm validate` - runs `lint`, `test:ci` and `test:e2e:ci`.