rsnext/examples/with-unsplash
Craig Wheeler 57426a2849
Update Examples to use React 18 (#42027)
This PR updates the minimum version of React used by examples from 17.0.2 to 18.2.0.

Fixes #41975

## Bug

- [x] Related issues linked using `fixes #41975`
- [ ] Integration tests added
- [ ] Errors have a helpful link attached, see `contributing.md`

## Feature

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have a helpful link attached, see `contributing.md`

## Documentation / Examples

- [x] Make sure the linting passes by running `pnpm build && pnpm lint`
- [x] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md)
2022-10-28 17:43:20 +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 [Docs] Update examples to favour functional _document (#39871) 2022-08-23 18:52:31 +00: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 Update default gitignore templates (#39051) 2022-07-26 20:08:40 -05:00
package.json Update Examples to use React 18 (#42027) 2022-10-28 17:43:20 +00:00
README.md docs(examples): improve DX while copying command to create new project (#38410) 2022-07-26 21:57:48 -05: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, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example with-unsplash with-unsplash-app
yarn create next-app --example with-unsplash with-unsplash-app
pnpm 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

Create a new application on Unsplash.

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