https://github.com/shin-sforzando/etude-vite-vue3
Etude for Vue3 using Vite
https://github.com/shin-sforzando/etude-vite-vue3
Last synced: about 1 month ago
JSON representation
Etude for Vue3 using Vite
- Host: GitHub
- URL: https://github.com/shin-sforzando/etude-vite-vue3
- Owner: shin-sforzando
- License: mit
- Created: 2022-11-10T03:33:20.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-07T23:45:57.000Z (almost 2 years ago)
- Last Synced: 2025-02-03T06:35:40.631Z (3 months ago)
- Language: Vue
- Size: 1.52 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# etude-vite-vue3
[](https://github.com/shin-sforzando/etude-vite-vue3/graphs/commit-activity)
[](https://github.com/shin-sforzando/etude-vite-vue3/actions/workflows/ci.yml)
[](http://commitizen.github.io/cz-cli/)
[](https://opensource.org/licenses/MIT)
|  |  |
| :------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------: |
| Screenshot 1 | Screenshot 2 |
**etude-vite-vue3** is a repository for studying Vite + Vue3.
---
- [Prerequisites](#prerequisites)
- [How to](#how-to)
- [Setup](#setup)
- [Reveal Secrets](#reveal-secrets)
- [Environment Variables](#environment-variables)
- [Develop](#develop)
- [Document](#document)
- [CHANGELOG.md](#changelogmd)
- [Deploy](#deploy)
- [Misc](#misc)
- [Notes](#notes)
- [LICENSE](#license)
- [Contributors](#contributors)
## Prerequisites
- Node.js
- [Vite](https://ja.vitejs.dev)
- Vue 3
- ESLint
- Stylelint
- Prettier
- Storybook
- [git-secret](https://git-secret.io)
## How to
```shell
$ npm run
Lifecycle scripts included in [email protected]:
test
echo 'Not Implemented Yet'
available via `npm run-script`:
prepare
husky install
hide
git secret hide -vm
reveal
git secret reveal -vf
dev
vite --host 0.0.0.0
build
vue-tsc && vite build
preview
vite preview --host 0.0.0.0
lint:script
eslint --ignore-path .gitignore './**/*.{js,ts,vue}' --fix
lint:style
stylelint './**/*.{css,scss,vue}' --fix
format
prettier --ignore-unknown './**/*.{js,cjs,ts,vue,css,html,json}' --write
storybook
NODE_OPTIONS='--openssl-legacy-provider' start-storybook -p 6006
build-storybook
NODE_OPTIONS='--openssl-legacy-provider' build-storybook
chromatic
npx chromatic --project-token=$CHROMATIC_PROJECT_TOKEN
```
### Setup
#### Reveal Secrets
To reveal secret files, `npm run reveal`.
To hide secret files, `npm run hide`.
#### Environment Variables
```.env
(T. B. D.)
```
### Develop
`npm run dev` to start development server.
### Document
#### CHANGELOG.md
To update CHANGELOG.md, `git cliff --unreleased --output CHANGELOG.md`.
### Deploy
(T. B. D.)
## Misc
### Notes
This repository is [Commitizen](https://commitizen.github.io/cz-cli/) friendly, following [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow).
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
### LICENSE
This project is licensed under the MIT License, see the [LICENSE](./LICENSE) for details.
### Contributors
- [sforzando LLC. and Inc.](https://sforzando.co.jp/)
- [Shin'ichiro Suzuki](https://github.com/shin-sforzando)