|
1 |
| -# create-nuxt-app |
| 1 | +# Create Nuxt App |
2 | 2 |
|
3 |
| -[](https://npmjs.com/package/create-nuxt-app) [](https://npmjs.com/package/create-nuxt-app) [](https://circleci.com/gh/nuxt-community/create-nuxt-app/tree/master) [](https://github.com/egoist/donate) |
| 3 | +[](https://npmjs.com/package/create-nuxt-app) [](https://npmjs.com/package/create-nuxt-app) |
| 4 | + |
| 5 | +> Create a [Nuxt.js](https://github.com/nuxt/nuxt.js) project in seconds |
4 | 6 |
|
5 | 7 | <details><summary>Preview</summary>
|
6 | 8 |
|
7 | 9 | 
|
8 | 10 | </details>
|
9 | 11 |
|
10 |
| -## Install |
| 12 | +## Usage |
| 13 | + |
| 14 | +Make sure you have [npx](https://www.npmjs.com/package/npx) installed (`npx` is shipped by default since NPM `5.2.0`) |
11 | 15 |
|
12 | 16 | ```bash
|
13 |
| -yarn global add create-nuxt-app |
| 17 | +npx create-nuxt-app <my-project> |
14 | 18 | ```
|
15 | 19 |
|
16 |
| -## Usage |
| 20 | +Or with [yarn](https://yarnpkg.com/en/): |
17 | 21 |
|
18 | 22 | ```bash
|
19 |
| -create-nuxt-app my-project |
| 23 | +yarn create nuxt-app <my-project> |
20 | 24 | ```
|
21 | 25 |
|
22 |
| -## Contributing |
23 |
| - |
24 |
| -1. Fork it! |
25 |
| -2. Create your feature branch: `git checkout -b my-new-feature` |
26 |
| -3. Commit your changes: `git commit -am 'Add some feature'` |
27 |
| -4. Push to the branch: `git push origin my-new-feature` |
28 |
| -5. Submit a pull request :D |
29 |
| - |
30 |
| -## Author |
31 |
| - |
32 |
| -**create-nuxt-app** © [egoist](https://github.com/egoist), Released under the [MIT](./LICENSE) License.<br> |
33 |
| -Authored and maintained by egoist with help from contributors ([list](https://github.com/nuxt-community/create-nuxt-app/contributors)). |
34 |
| - |
35 |
| -> [egoist.moe](https://egoist.moe) · GitHub [@egoist](https://github.com/egoist) · Twitter [@_egoistlily](https://twitter.com/_egoistlily) |
| 26 | +## Features :tada: |
| 27 | + |
| 28 | +1. Choose between integrated server-side frameworks: |
| 29 | + - None (Nuxt default server) |
| 30 | + - [Express](https://github.com/expressjs/express) |
| 31 | + - [Koa](https://github.com/koajs/koa) |
| 32 | + - [Hapi](https://github.com/hapijs/hapi) |
| 33 | + - [Feathers](https://github.com/feathersjs/feathers) |
| 34 | + - [Micro](https://github.com/zeit/micro) |
| 35 | + - [Adonis](https://github.com/adonisjs/adonis-framework) (WIP) |
| 36 | +2. Choose your favorite UI framework: |
| 37 | + - None (feel free to add one later) |
| 38 | + - [Bootstrap](https://github.com/bootstrap-vue/bootstrap-vue) |
| 39 | + - [Vuetify](https://github.com/vuetifyjs/vuetify) |
| 40 | + - [Bulma](https://github.com/jgthms/bulma) |
| 41 | + - [Tailwind](https://github.com/tailwindcss/tailwindcss) |
| 42 | + - [Element UI](https://github.com/ElemeFE/element) |
| 43 | +3. Add [axios module](https://github.com/nuxt-community/axios-module) to make HTTP request easily into your application. |
| 44 | +3. Add [EsLint](https://eslint.org/) to Lint your code on save. |
| 45 | + |
| 46 | +## Credits |
| 47 | + |
| 48 | +- [egoist](https://github.com/egoist) |
| 49 | +- [clarko](https://github.com/clarkdo) |
| 50 | +- All our contributors ([list](https://github.com/nuxt-community/create-nuxt-app/contributors)). |
0 commit comments