Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a preact example. #543

Merged
merged 2 commits into from
Dec 27, 2016
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions examples/using-preact/.babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"presets": [
"es2015",
"react"
]
}
33 changes: 33 additions & 0 deletions examples/using-preact/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@

# Hello World example

## How to use

Download the example (or clone the repo)[https://github.com/zeit/next.js.git]:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.git not needed here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just copied this from the hello-world example. May be we need to change this for all examples. Shall we do it with another PR?


```bash
curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/using-preact
cd using-preact
```

Install it and run:

```bash
npm install
npm run dev
```

Deploy it to the cloud with [now](https://zeit.co/now) ([download](https://zeit.co/download))

```bash
now
```

## The idea behind the example

This example uses [Preact](https://github.com/developit/preact) instead of React. It's a React like UI framework which fast and small. Here we've customized Next.js to use Preact instead of React.

Here's how we did it:

* Create `.babelrc` file with es2015 and react presets. This allow us to get rid of the hard coded React dependency for core Next.js modules.
* Use `next.config.js` to customize our webpack config to support [preact-compat](https://github.com/developit/preact-compat)
9 changes: 9 additions & 0 deletions examples/using-preact/next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
module.exports = {
webpack: function (config) {
config.resolve.alias = {
'react': 'preact-compat',
'react-dom': 'preact-compat'
}
return config
}
}
20 changes: 20 additions & 0 deletions examples/using-preact/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "hello-world",
"version": "1.0.0",
"scripts": {
"dev": "next",
"build": "next build",
"start": "next start"
},
"dependencies": {
"next": "^2.0.0-beta",
"preact": "^7.1.0",
"preact-compat": "^3.9.4"
},
"author": "",
"license": "ISC",
"devDependencies": {
"babel-preset-es2015": "^6.18.0",
"babel-preset-react": "^6.16.0"
}
}
5 changes: 5 additions & 0 deletions examples/using-preact/pages/about.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import React from 'react'

export default () => (
<div>About us</div>
)
6 changes: 6 additions & 0 deletions examples/using-preact/pages/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import React from 'react'
import Link from 'next/link'

export default () => (
<div>Hello World. <Link href='/about'>About</Link></div>
)