rsnext/examples/with-unsplash
Luc Leray 8eaabe2fb0
Fix deploy buttons URLs (#20834)
Fix all deploy button URLs in the Next.js repo to follow the following format:
```
https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/<EXAMPLE_NAME>&project-name=<EXAMPLE_NAME>&repository-name=<EXAMPLE_NAME>
```

The detailed docs for the Deploy Button can be found here: https://vercel.com/docs/more/deploy-button.

Also updates legacy Vercel import flow URLs (starting with vercel.com/import or with vercel.com/new/project), to use the new vercel.com/new URLs.

---

For example, for the `hello-world` example:

The URL is https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/hello-world&project-name=hello-world&repository-name=hello-world

And the deploy button looks like this:
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/hello-world&project-name=hello-world&repository-name=hello-world)

---

For reference, I used the following regexes to search for the incorrect URLs

```
\(https://vercel.com/import/git\?s=https://github.com/vercel/next.js/tree/canary/examples/(.*)\)
\(https://vercel.com/import/git\?c=1&s=https://github.com/vercel/next.js/tree/canary/examples/([^&]*)(.*)\)
\(https://vercel.com/import/project\?template=https://github.com/vercel/next.js/tree/canary/examples/(.*)\)
https://vercel.com/import/git
https://vercel.com/import/select-scope
https://vercel.com/import
https://vercel.com/new/project
```
2021-01-07 01:40:29 +00:00
..
components Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
docs Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
libs Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
pages Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
public Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
styles Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
.env.local.example Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
.gitignore Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
next-env.d.ts Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
package.json Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00
README.md Fix deploy buttons URLs (#20834) 2021-01-07 01:40:29 +00:00
tsconfig.json Add example: Unsplash integration (#16142) 2020-08-22 16:02:49 -05:00

Using Next.js with Unsplash API

This is an example of how Unsplash can be used with Next.js

Deploy your own

Once you have access to the environment variables you'll need, deploy the example using Vercel:

Deploy with Vercel

How to use

Execute create-next-app with npm or Yarn to bootstrap the example:

npx create-next-app --example with-unsplash with-unsplash-app
# or
yarn create next-app --example with-unsplash with-unsplash-app

Configuration

First, you'll need to create an account on Unsplash if you don't have one already. Once that's done, follow the steps below.

Step 1. Create an app on Unsplash

To create a new application on Unsplash, click here or go to https://unsplash.com/oauth/applications/new.

Before creating an app you'll have to accept the terms for API use:

Accept Unsplash app terms

Then, fill the form with the app name and description, and click on on Create application to finish the creation of your app:

Form to fill app name and description

Step 2. Set up environment variables

After creating the app, you should be able to see the API keys in the settings page of your app:

API Keys of Unsplash app

We'll need those API keys to connect the example with your Unsplash app.

First, copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then set each variable on .env.local:

  • UNSPLASH_ACCESS_KEY should be the Access Key of your Unsplash app
  • UNSPLASH_USER should be any valid Unsplash username. The example will use the photos of the user selected here.

Step 3. Run Next.js in development mode

npm install
npm run dev

# or

yarn install
yarn dev

Your app should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.

Step 4. Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

Deploy Your Local Project

To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and import to Vercel.

Important: When you import your project on Vercel, make sure to click on Environment Variables and set them to match your .env.local file.

Deploy from Our Template

Alternatively, you can deploy using our template by clicking on the Deploy button below.

Deploy with Vercel