vuesion / docs

Documentation of the @vuesion project

Vuesion

Vuesion is a boilerplate that helps product teams build faster than ever with fewer headaches and modern best practices across engineering & design.

Live demo

Please visit the vuesion app on heroku!

Or have a look into the future and visit the vuesion-next app on heroku!

Get started

Documentation

Features

Testing

• Cypress.io E2E testing
• Vitest Testing framework
• Testing-library to encourage good testing practices
• 250+ example tests included

DX, Code quality and maintenance

• TypeScript
• Eslint
• Commit message linting
• Prettier code formatting
• Semantic releases
• Changelog
• Husky pre-commit hooks
• Dockerfile included
• .env support

Core

• server-side-rendering, single-page-app or statically generated HTML with Nuxt.js
• 100% customizable Design-system with 35+ components including
  • layout, typography, button, input, select, checkbox, radio, (range-)slider, toggle, ...
  • theming/whitelabel support
• Figma UIKit
• SEO support
• i18n support
• Authentication module
• Axios module
• PWA module
• Code generators for
  • components
  • pages
  • interfaces and fixtures
  • vuex modules
• Storybook with the following add-ons
  • a11y
  • actions
  • console
  • links
  • story-source
  • viewport
  • theme-switcher
• Form validation with vee-validate
• Anime.js integration

Support this project

• Give a ⭐!
• it!
• Join the Discord community!
• Contribute!

Contribute

Contributions are always welcome! Please read the contribution guidelines first.

Thanks goes to these wonderful people:

Johannes Werner 💻 🐛 📖 🎨 💡 🔧	Konstantin Kulinicenko 💻 🐛 📖 💡	xMartin 💻 🐛 📖 💡	Silver·湫澲 📖 🌍	Stavros Liaskos 🐛	Marcelo Boeira 🌍	Rick Mann 💻
Ryan McGuire 💻	Jay McDoniel 💻	Olivia Graham 💻	Hugo Magalhães 🌍	glederer 📖	Tamer Mohamed 💻	Rizwan Zaheer 📖
rgrosjean 💻	Bernardo Corbella 💻	Mohit Tilwani 💻	eipiminus1 📖	Jez McKean 📖	Duylam Nguyen-Ngo 🎨	Martin Merschroth 🎨
Camila Peralta Wieland 🎨	Alec M 📖	misikoff 💻	臭哥哥·湫曗 📖	Paul Vogel 📖	Dario Fuzinato 💻	Maksim Bock ⚠️
Dan 🐛	Manuel J. Bernal 📖	Nguyen Kim Bang 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

References

• nuxt
• @sidebase/nuxt-auth
• nuxt/pwa
• nuxt/i18n
• Storybook
• vitest
• cypress.io
• testing-library
• vee-validate
• animejs

Contact

• Discord
• Twitter

License

MIT

docs's Issues

Guide: change order

currently, the guide doesn't work. the clean up step comes before adding a new module which breaks the application because the server-routes for the counter will be removed. we should change the order of the guide.

VueCalendar in the example code fails to pass the test

Describe the bug
A clear and concise description of what the bug is.

Description of the test indicates that the tests expects 50 years in the future and 50 in the past to be rendered, but it actually gets 70 in the future and 30 in to the past, but since the starting point is 1/1/2000 it fails on everyting.

what we get is 1970 at 1 and 2070 at x+n, this is 30 years in the past from 2000 and 70 in the future from 2000
Ether the test tests for the worng thig or the renders the wrong thing. Since it's not clear on the start guide if the the test is ment to fail and requires the user to update the code or if this is a mistake I decided to report the issue.

file: VueCalendar.spec.ts
line: 206

docs: second review, improve localization for zh-cn

docs: second review, improve localization for zh-cn

Assignee : @silverleaves

Add: Tipps / Common Pitfalls Section

common pitfalls:

• updating arrays in computed properties or vuex with slice instead of the index of the array element
• tbd ...

Add Spanish documentation

I want to contribute to this project helping to add the Spanish documentation.

I can interpretation or translation to Spanish of the current documentation.

Let me know if you are agreed to start

fix: generate module with a path

when running npm run generate to generate module using a path (i.e. Pages/test), router.ts and state.ts doesn't use correct path

Expected path: './Pages/test/state'
Generated path: './test/state'