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

Added universal configuration example #991

Merged
merged 2 commits into from
Feb 4, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
8 changes: 8 additions & 0 deletions examples/with-universal-configuration/.babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"presets": [
"next/babel"
],
"plugins": [
["transform-define", "./env-config.js"]
]
}
28 changes: 28 additions & 0 deletions examples/with-universal-configuration/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@

# With universal configuration

## How to use

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

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

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 show how to set custom environment variables for your application based on NODE_ENV using [transform-define](https://github.com/FormidableLabs/babel-plugin-transform-define).
5 changes: 5 additions & 0 deletions examples/with-universal-configuration/env-config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
const prod = process.env.NODE_ENV === 'production'

module.exports = {
'MY_ENV_VARIABLE': prod ? 'production' : 'development'
Copy link
Contributor

@arunoda arunoda Feb 4, 2017

Choose a reason for hiding this comment

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

Shall we use a bit more realistic example. For an example, let's create a variable called BACKEND_URL.

Use different URLs based other env.

In the component, just say "loading data from: BACKEND_URL"

Copy link
Member Author

Choose a reason for hiding this comment

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

Done 👍

}
17 changes: 17 additions & 0 deletions examples/with-universal-configuration/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "with-env",
"version": "1.0.0",
"scripts": {
"dev": "next",
"build": "next build",
"start": "next start"
},
"dependencies": {
"next": "^2.0.0-beta"
},
"devDependencies": {
"babel-plugin-transform-define": "^1.2.0"
},
"author": "",
"license": "ISC"
}
5 changes: 5 additions & 0 deletions examples/with-universal-configuration/pages/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
/* global MY_ENV_VARIABLE */

export default () => (
<div>Hello visitor from { MY_ENV_VARIABLE }</div>
)