diff --git a/README.md b/README.md index f73693ef62..80b26f3f0b 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,31 @@ Learn more at . +## Getting started + +```sh +$ npx create-nuxt-app +``` + +It's as simple as that! + +Learn more at https://nuxtjs.org/guide/installation + +## Examples + +Please take a look at or directly in . + +## Production deployment + +To deploy, instead of running nuxt, you probably want to build ahead of time. Therefore, building and starting are separate commands: + +```bash +nuxt build +nuxt start +``` + +Learn more at https://nuxtjs.org/guide/commands#production-deployment + ## Consulting from the Nuxt team Get help with that tough bug or make sure your Nuxt app is ready to deploy. For $250 an hour, get technical support, advice, code reviews, and development from the Nuxt core team: [Hire Nuxt on Otechie](https://otechie.com/nuxt?ref=readme) @@ -85,111 +110,6 @@ Support us with a monthly donation and help us continue our activities. [[Become [![Open Collective Nuxters][nuxters-src]][nuxters-href] -## Getting started - -```sh -$ npx create-nuxt-app -``` - -It's as simple as that! - -## Templates - -:point_right: We recommend to start directly with our cli [create-nuxt-app](https://github.com/nuxt-community/create-nuxt-app) for the latest updates. - -Or you can start by using one of our starter templates: - -- [express](https://github.com/nuxt-community/express-template): Nuxt.js + Express -- [koa](https://github.com/nuxt-community/koa-template): Nuxt.js + Koa -- [adonuxt](https://github.com/nuxt-community/adonuxt-template): Nuxt.js + AdonisJS -- [micro](https://github.com/nuxt-community/micro-template): Nuxt.js + Micro -- [nuxtent](https://github.com/nuxt-community/nuxtent-template): Nuxt.js + Nuxtent module for content heavy sites - -## Using nuxt.js programmatically - -```js -const { Nuxt, Builder } = require('nuxt') - -// Import and set nuxt.js options -const config = require('./nuxt.config.js') -config.dev = (process.env.NODE_ENV !== 'production') - -const nuxt = new Nuxt(config) - -// Start build process (only in development) -if (config.dev) { - new Builder(nuxt).build() -} - -// You can use nuxt.render(req, res) or nuxt.renderRoute(route, context) -``` - -Learn more: - -## Using nuxt.js as a middleware - -You might want to use your own server with your configurations, your API and everything awesome you have created with. That's why you can use nuxt.js as a middleware. It's recommended to use it at the end of your middleware since it will handle the rendering of your web application and won't call next(). - -```js -app.use(nuxt.render) -``` - -Learn more: - -## Render a specific route - -This is mostly used for `nuxt generate` and test purposes but you might find another utility! - -```js -nuxt.renderRoute('/about', context) -.then(function ({ html, error }) { - // You can check error to know if your app displayed the error page for this route - // Useful to set the correct status code if an error appended: - if (error) { - return res.status(error.statusCode || 500).send(html) - } - res.send(html) -}) -.catch(function (error) { - // And error appended while rendering the route -}) -``` - -Learn more: - -## Examples - -Please take a look at or directly in . - -## Production deployment - -To deploy, instead of running nuxt, you probably want to build ahead of time. Therefore, building and starting are separate commands: - -```bash -nuxt build -nuxt start -``` - -For example, to deploy with [`now`](https://zeit.co/now) a `package.json` like follows is recommended: - -```json -{ - "name": "my-app", - "dependencies": { - "nuxt": "latest" - }, - "scripts": { - "dev": "nuxt", - "build": "nuxt build", - "start": "nuxt start" - } -} -``` - -Then run `now` and enjoy! - -Note: we recommend putting `.nuxt` in `.npmignore` or `.gitignore`. - ## Core team @@ -206,6 +126,8 @@ Thank you to all our [contributors](https://github.com/nuxt/nuxt.js/graphs/contr ## Contributing +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/nuxt/nuxt.js) + Please refer to our [Contribution Guide](https://nuxtjs.org/guide/contribution-guide#codefund_ad) ## Cross-browser testing