dogstudio / dogstudio-nuxt-starter

Opinionated Nuxt starter by Dogstudio

Dogstudio Nuxt Starter

The repository has all the features needed to build blazing-fast experience.

• Nuxt 3
• Prettier
• SCSS/SASS

Prerequisites

• Node.js - LTS

Getting Started

git clone [email protected]:Dogstudio/dogstudio-nuxt-starter.git my-new-app

cd my-new-app
cp .env.example .env

npm i
npm run dev

Documentation

We recommend the following documentations to master the stack:

• Vue
• Nuxt
• Pinia
• Style Guide
• Atomic Design Pattern

References

# Run Nuxt in development-mode with a local server.
# Visit http://localhost:3000 to see your application running.
npm run dev

# Run Nuxt in production-mode and creates a production build.
npm run build

# Run Nuxt in production-mode with a local server.
# Visit http://localhost:3000 to see your production build.
npm run start

# Run Nuxt in production-mode and generates static files.
npm run generate

# Run ESLint for JS & Vue files
npm run lint

# Upgrade the dependencies and devDependencies with interactive mode
# See: https://www.npmjs.com/package/npm-check-updates
npm run upgrade

Example

An example is available on the demo branch to test all the features included in the repository:

git checkout demo

npm i
npm run dev

Contributing

Please submit issues, pull requests or contact us. We are open to all kind of contributions.

License

The dogstudio-nuxt-starter repository is MIT licensed.

Roadmap

• ✅ Upgrade dependencies and devDependencies
• ✅ Migrate architecture from Nuxt 2 to Nuxt 3
• ✅ Migrate plugins from Nuxt 2 to Nuxt 3
• ✅ Migrate Vue 2 to Vue 3 with Composition API
• ✅ Test icons imports
• ✅ Test fonts imports
• ✅ Test images imports
• ✅ Test videos imports
• ✅ Test audios imports
• ✅ Test styles imports
• ✅ Test shaders imports
• ✅ Test components imports
• ✅ Test environment variables
• 🚧 Upgrade @nuxtjs/i18n to next stable version