https://github.com/dogstudio/dogstudio-nuxt-starter
Opinionated Nuxt starter by Dogstudio
https://github.com/dogstudio/dogstudio-nuxt-starter
nuxt nuxt-template nuxtjs starter starter-kit vue vuejs
Last synced: about 1 year ago
JSON representation
Opinionated Nuxt starter by Dogstudio
- Host: GitHub
- URL: https://github.com/dogstudio/dogstudio-nuxt-starter
- Owner: Dogstudio
- License: mit
- Created: 2021-11-25T12:55:12.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2025-03-20T16:31:37.000Z (about 1 year ago)
- Last Synced: 2025-03-30T22:23:54.631Z (about 1 year ago)
- Topics: nuxt, nuxt-template, nuxtjs, starter, starter-kit, vue, vuejs
- Language: Vue
- Homepage: https://dogstudio-nuxt-starter.vercel.app
- Size: 5.26 MB
- Stars: 16
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Dogstudio Nuxt Starter
The repository has all the features needed to build blazing-fast experience.
- Nuxt 3
- Prettier
- SCSS/SASS
## Prerequisites
- [Node.js - LTS](https://nodejs.org/en/download/)
## Getting Started
```bash
git clone git@github.com:Dogstudio/dogstudio-nuxt-starter.git my-new-app
```
```bash
cd my-new-app
cp .env.example .env
```
```bash
npm i
npm run dev
```
## Documentation
We recommend the following documentations to master the stack:
- [Vue](https://vuejs.org/guide/introduction.html)
- [Nuxt](https://v3.nuxtjs.org/getting-started/introduction)
- [Pinia](https://pinia.vuejs.org/ssr/nuxt.html#installation)
- [Style Guide](https://vuejs.org/style-guide/)
- [Atomic Design Pattern](https://atomicdesign.bradfrost.com/table-of-contents/)
## References
```bash
# 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:
```bash
git checkout demo
```
```bash
npm i
npm run dev
```
## Contributing
Please submit issues, pull requests or [contact us](devops+nuxt-starter@dogstudio.be). We are open to all kind of contributions.
## License
The `dogstudio-nuxt-starter` repository is [MIT licensed](/LICENSE.md).