mirror of https://github.com/terribleplan/next.js.git synced 2024-01-19 02:48:18 +00:00

Go to file

Dan Zajdband 97ad053855 Added next init command for starting a new project (#15 ) * Added next bootstrap command for starting a new project * renamed bootstrap to init and check we are not in a dir called pages * Removed extra empty line		2016-10-16 16:55:30 -07:00
bench	Added benchmark suite	2016-10-13 16:01:11 -04:00
bin	Added next init command for starting a new project (#15 )	2016-10-16 16:55:30 -07:00
client	apply css on server rendering	2016-10-09 18:50:41 +09:00
examples	add some basic examples	2016-10-15 23:31:05 -05:00
lib	Reverting default props for errors. (#12 )	2016-10-16 15:44:26 -07:00
server	Reverting default props for errors. (#12 )	2016-10-16 15:44:26 -07:00
test	Added async props test (#9 )	2016-10-15 23:32:58 -05:00
.gitignore	Set test command and added more tests	2016-10-12 19:15:58 -04:00
gulpfile.js	Added benchmark suite	2016-10-13 16:01:11 -04:00
package.json	Added benchmark suite	2016-10-13 16:01:11 -04:00
Readme.md	Reverting default props for errors. (#12 )	2016-10-16 15:44:26 -07:00

Readme.md

next.js

Next.js is a minimalistic framework for server-rendered React applications.

How to use

The file-system is the main API. Every .js file becomes a route that gets automatically processed and rendered.

Populate ./pages/index.js inside your project:

import React from 'react'
export default () => (
  <div>Welcome to next.js!</div>
)

and then just run next and go to http://localhost:3000

So far, we get:

Automatic transpilation and bundling (with webpack and babel)
Hot code reloading
Server rendering and indexing of ./pages
Static file serving. ./static/ is mapped to /static/

Bundling (code splitting)

Every import you declare gets bundled and served with each page

import React from 'react'
import cowsay from 'cowsay-browser'
export default () => (
  <pre>{ cowsay({ text: 'hi there!' }) }</pre>
)

That means pages never load unneccessary code!

CSS

We use Aphrodite to provide a great built-in solution for CSS modularization

import React from 'react'
import { css, StyleSheet } from 'next/css'

export default () => (
  <div className={ css(styles.main) }>
    Hello world
  </div>
)

const styles = StyleSheet.create({
  main: {
    background: 'red',
    '@media (max-width: 600px)': {
      background: 'blue'
    }
  }
})

`<head>` side effects

We expose a built-in component for appending elements to the <head> of the page.

import React from 'react'
import Head from 'next/head'
export default () => (
  <div>
    <Head>
      <title>My page title</title>
      <meta name="viewport" content="initial-scale=1.0, width=device-width" />
    </Head>
    <p>Hello world!</p>
  </div>
)

Stateful components

When state, lifecycle hooks or initial data population you can export a React.Component:

import React from 'react'
export default class extends React.Component {
  static async getInitialProps ({ req }) {
    return req
      ? { userAgent: req.headers.userAgent }
      : { userAgent: navigator.userAgent }
  }

  render () {
    return <div>
      Hello World {this.props.userAgent}
    </div>
  }
}

Routing

Client-side transitions between routes are enabled via a <Link> component

pages/index.js

import React from 'react'
import Link from 'next/link'
export default () => (
  <div>Click <Link href="/about"><a>here</a></Link> to read more</div>
)

pages/about.js

import React from 'react'
export default () => (
  <p>Welcome to About!</p>
)

Client-side routing behaves exactly like the native UA:

The component is fetched
If it defines getInitialProps, data is fetched. If an error occurs, _error.js is rendered
After 1 and 2 complete, pushState is performed and the new component rendered

Each top-level component receives a url property with the following API:

path - String of the current path excluding the query string
query - Object with the parsed query string. Defaults to {}
push(url) - performs a pushState call associated with the current component
replace(url) - performs a replaceState call associated with the current component
pushTo(url) - performs a pushState call that renders the new url. This is equivalent to following a <Link>
replaceTo(url) - performs a replaceState call that renders the new url

Error handling

404 or 500 errors are handled both client and server side by a default component error.js. If you wish to override it, define a _error.js:

import React from 'react'

export default class Error extends React.Component {
  static getInitialProps ({ res, xhr }) {
    const statusCode = res ? res.statusCode : xhr.status
    return { statusCode }
  }

  render () {
    return (
      <p>An error { this.props.statusCode } occurred</p>
    )
  }
}

Production deployment

To deploy, run:

next build
next start

For example, to deploy with now a package.json like follows is recommended:

{
  "name": "my-app",
  "dependencies": {
    "next": "latest"
  },
  "scripts": {
    "dev": "next",
    "build": "next build",
    "start": "next start"
  }
}

In progress

The following tasks are planned and part of our roadmap

Add option to supply a req, res handling function for custom routing
Add option to extend or replace custom babel configuration
Add option to extend or replace custom webpack configuration
Investigate pluggable component-oriented rendering backends (Inferno, Preact, etc)