README.md

Create Nuxt App

Create a Nuxt.js project in seconds

Usage

Make sure you have npx installed (npx is shipped by default since npm 5.2.0)

npx create-nuxt-app <my-project>

Or starting with npm v6.1 you can do:

npm init nuxt-app@latest <my-project>

Or with yarn:

yarn create nuxt-app <my-project>

Features 🎉

1. Package manager
   • Yarn
   • Npm
2. Programming language
   • JavaScript
   • TypeScript
3. UI framework:
   • None (feel free to add one later)
   • Ant Design Vue
   • BalmUI
   • Bootstrap
   • Buefy
   • Chakra UI
   • Element
   • Oruga
   • Primevue/
   • Tachyons
   • Tailwind CSS
   • Windi CSS
   • Vant
   • View UI
   • Vuetify
4. Template engine
   • HTML
   • Pug
5. Nuxt.js modules:
   • Axios - Promise based HTTP client
   • Progressive Web App (PWA)
   • Content - Git-based headless CMS
6. Linting tools:
   • ESLint
   • Prettier
   • Lint staged files
   • StyleLint
   • Commitlint
7. Testing framework:
   • None
   • Jest
   • AVA
   • WebdriverIO
   • Nightwatch
8. Rendering mode
   • Universal (SSR / Static)
   • SPA
9. Deployment target
   • Server (Node.js hosting)
   • Static (Static/JAMStack hosting)
10. Development tools
    • jsconfig.json
    • Semantic PR
    • Dependabot (for GitHub only)
11. Continuous Integration
    • GitHub Actions
    • Travis CI
    • CircleCI

CLI Options

--edge

Alias: -e.

To install nuxt-edge instead of nuxt, add the command line option --edge:

npx create-nuxt-app <my-project> --edge

Or

npm init nuxt-app <my-project> --edge

Or

yarn create nuxt-app <my-project> --edge

--info

Alias: -i. Print out debugging information relating to the local environment and exit.

--help

Alias: -h. Show the help information and exit, include: usage, command and all cli options.

--verbose

Show debug logs

--version

Alias: -v. Show version number and exit.

--overwrite-dir

Overwrite the target directory.

Credits

• egoist
• clarko
• All our contributors (list).