https://github.com/dochner/vivu-template
https://github.com/dochner/vivu-template
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dochner/vivu-template
- Owner: dochner
- License: mit
- Created: 2021-12-28T12:00:33.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-28T12:00:34.000Z (over 4 years ago)
- Last Synced: 2025-02-03T16:24:33.621Z (over 1 year ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
Vivu
## Learn 7AD
Learn the design patterns [here](https://github.com/logustra/7ad)
## Features
- Faster by default: [vite](https://github.com/vitejs/vite), [vue](https://github.com/vuejs/vue-next), [pnpm](https://github.com/pnpm/pnpm), [esbuild](https://github.com/evanw/esbuild)
- Vue 3 ecosystem: [vue](https://github.com/vuejs/vue-next), [vuex](https://next.vuex.vuejs.org), [vue-router](https://github.com/vuejs/vue-router-next)
- Typescript, of course
- Using new `` style
- Support legacy browsers: [@vitejs/plugin-legacy](https://github.com/vitejs/vite/tree/main/packages/plugin-legacy)
- Composition utilities: [vueuse](https://github.com/vueuse/vueuse)
- Fonts auto injecting: [vite-plugin-fonts](https://github.com/stafyniaksacha/vite-plugin-fonts)
- Just in time css utilities: [tailwindcss](https://github.com/tailwindlabs/tailwindcss)
- On-demand components auto importing: [iconify](https://github.com/antfu/vite-plugin-icons), [element-plus](https://github.com/element-plus/element-plus)
- Form validation: [vuelidate](https://vuelidate-next.netlify.app)
- Localization: [vue-i18n](https://github.com/intlify/vue-i18n-next), [vite-plugins-i18n](https://github.com/intlify/vite-plugin-vue-i18n)
- UI Documentation: [storybook](https://github.com/storybookjs/storybook) (ON PROGRESS)
- Testing: [jest](https://github.com/facebook/jest), [testing-library](https://testing-library.com/docs/vue-testing-library/intro)
- HTTP request: [axios](https://github.com/axios/axios)
- Git custom hooks: [husky](https://github.com/typicode/husky)
- Commit conventions: [commitizen](https://github.com/commitizen/cz-cli)
- Linters: [commitlint](https://github.com/conventional-changelog/commitlint), [eslint](https://github.com/eslint/eslint), [stylelint](https://github.com/stylelint/stylelint)
- Visualize bundle: [rollup-plugin-visualizer](https://github.com/btd/rollup-plugin-visualizer)
- Optimized nginx config
- Dockerize
## Dev Tools
- [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar): Vue 3 IDE support
- [Iconify IntelliSense](https://marketplace.visualstudio.com/items?itemName=antfu.iconify): Icon inline display and autocomplete
- [i18n Ally](https://marketplace.visualstudio.com/items?itemName=lokalise.i18n-ally): All in one i18n support
- [Tailwind CSS Intellisense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss): IDE support for Tailwind CSS
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
## Requirement
- [node.js](http://nodejs.org/)
- [volta](https://docs.volta.sh/guide/getting-started)
- [pnpm](https://pnpm.js.org/en/installation)
## Getting Started
### GitHub Template
[Create a repo from this template on GitHub](https://github.com/logustra/vivu/generate).
### Clone to local
If you prefer to do it manually with the cleaner git history
```bash
# clone repository
$ git clone https://github.com/logustra/vivu.git
# open folder vivu
$ cd vivu
# install packages
$ pnpm install
# build and serve with vite dev server
$ pnpm dev
```
### Run with Docker
```bash
# build docker image and tag it with name nginx
$ docker build . -t nginx
# run docker image nginx with name vivu in port 9900
$ docker run -it -p 9900:80 --rm --name vivu nginx
```
## Checklist
When you use this template, try follow the checklist to update your info properly
- [ ] Change `name, description, repository, bugs` field in `package.json`
- [ ] Change the author name in `LICENSE`
- [ ] Change the title in `commonState.ts`
- [ ] Change the favicon in `public`
- [ ] Remove the `.github` folder which contains the funding info
- [ ] Clean up the README(s) and remove modules
And, enjoy :)
## How to Create Folder
A guide how to create a folder using `create-cli`
### Component
```bash
# create new atom component with name loading
$ node create component atoms loading
```
### Module
```bash
# create new module with name home and with all types
$ node create module home all
```
## How to Contribute
I'm delighted that you're helping make this open source project better. Here are a few quick guidelines to make this an easier and better process for everyone.
### Reporting a bug
First, **make sure the bug hasn't already been reported** by searching GitHub's issues section.
If no existing issue exists, go ahead and create one. **Please be sure to include all of the following**:
1. A clear, descriptive title (ie. "A bug" is not a good title).
2. Include the error message if have.
3. The browser and OS that you're using.
### Submitting a Pull Request
1. Fork it
2. Create your feature branch `git checkout -b new-feature`
3. Commit your changes `git commit -m "Add some feature"`
4. Push to the branch `git push origin new-feature`
5. Create new Pull Request
## License
[](https://app.fossa.io/projects/git%2Bgithub.com%2Flogustra%2Fvivu?ref=badge_large)