-
Notifications
You must be signed in to change notification settings - Fork 27.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'add/json-traces' of github.com:timneutkens/next.js into…
… add/json-traces
- Loading branch information
Showing
188 changed files
with
78,639 additions
and
75,201 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| COUCHBASE_USER= | ||
| COUCHBASE_PASSWORD= | ||
| COUCHBASE_ENDPOINT= | ||
| COUCHBASE_BUCKET= | ||
| IS_CLOUD_INSTANCE= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
| /.pnp | ||
| .pnp.js | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # next.js | ||
| /.next/ | ||
| /out/ | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
|
|
||
| # debug | ||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
|
|
||
| # local env files | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| # IDE Files | ||
| .idea/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| ## Example app using Couchbase | ||
|
|
||
| [Couchbase](https://www.couchbase.com/) is a modern database for enterprise applications. This example will show you how to connect to and use Couchbase in your Next.js app. | ||
|
|
||
| If you want to learn more about Couchbase, visit the following pages: | ||
|
|
||
| - [Couchbase Docs](https://docs.couchbase.com/) | ||
| - [Couchbase Developer Portal](https://developer.couchbase.com/) | ||
| - [Couchbase Cloud](https://cloud.couchbase.com/sign-up) | ||
|
|
||
| ## Preview | ||
|
|
||
| Preview the example live on [StackBlitz](http://stackblitz.com/): | ||
|
|
||
| [](https://stackblitz.com/github/vercel/next.js/tree/canary/examples/with-couchbase) | ||
|
|
||
| ## Deploy your own | ||
|
|
||
| Once you have access to the environment variables you'll need, deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example): | ||
|
|
||
| [](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-couchbase&project-name=with-couchbase&repository-name=with-couchbase&env=COUCHBASE_USER,COUCHBASE_PASSWORD,COUCHBASE_ENDPOINT,COUCHBASE_BUCKET,IS_CLOUD_INSTANCE&envDescription=Required%20to%20connect%20the%20app%20with%20Couchbase) | ||
|
|
||
| ## How to use | ||
|
|
||
| Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example: | ||
|
|
||
| ```bash | ||
| npx create-next-app --example with-couchbase with-couchbase-app | ||
| # or | ||
| yarn create next-app --example with-couchbase with-couchbase-app | ||
| ``` | ||
|
|
||
| Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). | ||
|
|
||
| ## Configuration | ||
|
|
||
| ### Set up a Couchbase database | ||
|
|
||
| Set up a Couchbase database either locally or with [Couchbase Cloud](https://cloud.couchbase.com/sign-up). | ||
|
|
||
| Local installation can be accomplished through a variety of methods, but [Docker](https://docs.couchbase.com/server/current/install/getting-started-docker.html) is the simplest. | ||
|
|
||
| After Couchbase is installed, set up a cluster by following [this tutorial](https://docs.couchbase.com/server/current/manage/manage-nodes/create-cluster.html). | ||
|
|
||
| - _NOTE:_ the **eventing** and **analytics** services can be unchecked if memory is a constraint (this is often the case with docker and other local installations). | ||
|
|
||
| A variety of sample buckets can be installed to get up and running with a data model quickly. | ||
|
|
||
| ### Set up environment variables | ||
|
|
||
| Copy the `env.local.example` file in this directory to `.env.local` (which will be ignored by Git): | ||
|
|
||
| ```bash | ||
| cp .env.local.example .env.local | ||
| ``` | ||
|
|
||
| Set each variable on `.env.local`: | ||
|
|
||
| - `COUCHBASE_USERNAME` - The username of an authorized user on your Couchbase instance | ||
| - `COUCHBASE_PASSWORD` - The corresponding password for the username specified above | ||
| - `COUCHBASE_ENDPOINT` - The endpoint to connect to. Use `localhost` for a local instance of Couchbase, or the Wide Area Network address for a cloud instance. | ||
| - `COUCHBASE_BUCKET` - The bucket you'd like to connect to for testing. | ||
| - `IS_CLOUD_INSTANCE` - `true` if you are trying to connect to an instance of Couchbase Cloud, `false` otherwise. | ||
|
|
||
| ### Run Next.js in development mode | ||
|
|
||
| ```bash | ||
| npm install | ||
| npm run dev | ||
| # or | ||
| yarn install | ||
| yarn dev | ||
| ``` | ||
|
|
||
| Your app should be up and running on [http://localhost:3000](http://localhost:3000)! If it doesn't work, post on [GitHub discussions](https://github.com/vercel/next.js/discussions). | ||
|
|
||
| You will either see a message stating "You are connected to Couchbase" or "You are NOT connected to Couchbase". Ensure that you have provided the correct environment variables. | ||
|
|
||
| When you are successfully connected, you can refer to the [Couchbase Node.js SDK docs](https://docs.couchbase.com/nodejs-sdk/current/hello-world/start-using-sdk.html) for further instructions on how to query your database. | ||
|
|
||
| ## Deploy on Vercel | ||
|
|
||
| You can deploy this app to the cloud with [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). | ||
|
|
||
| #### Deploy Your Local Project | ||
|
|
||
| To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and [import to Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example). | ||
|
|
||
| ## Notes | ||
|
|
||
| - When you import your project on Vercel, make sure to click on **Environment Variables** and set the keys to match your `.env.local` file. | ||
|
|
||
| - For a cloud deployment on Vercel, the **Environment Variables** values will need to **correspond to a cloud instance of Couchbase** (localhost will **NOT** connect from a remote server such as Vercel). Find info on [getting started with Couchbase cloud](https://developer.couchbase.com/tutorial-cloud-getting-started/). | ||
|
|
||
| - _Important:_ you will have to allowlist 0.0.0.0/0 as the IP address, since Vercel's serverless deployments use [dynamic IP addresses](https://vercel.com/docs/solutions/databases#allowing-&-blocking-ip-addresses) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| "private": true, | ||
| "scripts": { | ||
| "dev": "next dev", | ||
| "build": "next build", | ||
| "start": "next start" | ||
| }, | ||
| "dependencies": { | ||
| "couchbase": "^3.1.3", | ||
| "next": "latest", | ||
| "react": "^17.0.2", | ||
| "react-dom": "^17.0.2" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import '../styles/globals.css' | ||
|
|
||
| function MyApp({ Component, pageProps }) { | ||
| return <Component {...pageProps} /> | ||
| } | ||
|
|
||
| export default MyApp |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| import Head from 'next/head' | ||
| import styles from '../styles/Home.module.css' | ||
| import { connectToDatabase } from '../util/couchbase' | ||
|
|
||
| export default function Home({ isConnected }) { | ||
| return ( | ||
| <div className={styles.container}> | ||
| <Head> | ||
| <title>Create Next App</title> | ||
| <link rel="icon" href="/favicon.ico" /> | ||
| </Head> | ||
|
|
||
| <main className={styles.main}> | ||
| <h1 className={styles.title}> | ||
| Welcome to <a href="https://nextjs.org">Next.js with Couchbase!</a> | ||
| </h1> | ||
|
|
||
| {isConnected ? ( | ||
| <h2 className={`${styles.subtitle} ${styles.green}`}> | ||
| You are connected to Couchbase | ||
| </h2> | ||
| ) : ( | ||
| <> | ||
| <h2 className={`${styles.subtitle} ${styles.red}`}> | ||
| You are NOT connected to Couchbase. Try refreshing the page, and | ||
| if this error persists check the <code>README.md</code> for | ||
| instructions. | ||
| </h2> | ||
| <em className={styles.center}> | ||
| Note: if the database was recently started, you might have to | ||
| re-start the app (in dev mode) or re-deploy to your serverless | ||
| environment for changes to take effect. | ||
| </em> | ||
| </> | ||
| )} | ||
|
|
||
| <p className={styles.description}> | ||
| Get started by editing{' '} | ||
| <code className={styles.code}>pages/index.js</code> | ||
| </p> | ||
| </main> | ||
|
|
||
| <footer className={styles.footer}> | ||
| <a | ||
| href="https://vercel.com?utm_source=create-next-app&utm_medium=default-template&utm_campaign=create-next-app" | ||
| target="_blank" | ||
| rel="noopener noreferrer" | ||
| > | ||
| Powered by{' '} | ||
| <img src="/vercel.svg" alt="Vercel Logo" className={styles.logo} /> | ||
| </a> | ||
| </footer> | ||
| </div> | ||
| ) | ||
| } | ||
|
|
||
| export async function getServerSideProps(context) { | ||
| let connection = await connectToDatabase() | ||
|
|
||
| const { collection } = connection | ||
|
|
||
| // Check connection with a KV GET operation for a key that doesnt exist | ||
| let isConnected = false | ||
| try { | ||
| await collection.get('testingConnectionKey') | ||
| } catch (err) { | ||
| // error message will return 'document not found' if and only if we are connected | ||
| // (but this document is not present, we're only trying to test the connection here) | ||
| if (err.message === 'document not found') { | ||
| isConnected = true | ||
| } | ||
| // if the error message is anything OTHER THAN 'document not found', the connection is broken | ||
| } | ||
|
|
||
| return { | ||
| props: { isConnected }, | ||
| } | ||
| } |
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.