rsnext/examples/with-mysql
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 [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
lib [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
pages Fix: Build time error for with-mysql example #19635 (#19636) 2021-01-06 11:27:59 -05:00
scripts [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
styles [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
.env.local.example [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
.gitignore [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
next-env.d.ts [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
package.json [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
postcss.config.js [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
README.md Fix deploy buttons URLs (#20834) 2021-01-07 01:40:29 +00:00
tailwind.config.js [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00
tsconfig.json [examples] Add Next.js + MySQL example (#19452) 2020-11-23 19:13:09 -05:00

MySQL Example

This is an example of using MySQL in a Next.js project.

Demo

https://next-mysql.vercel.app

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-mysql next-mysql-app
# or
yarn create next-app --example with-mysql next-mysql-app

Configuration

Step 1. Set up a MySQL database

Set up a MySQL server either locally or any cloud provider.

Step 2. Set up environment variables

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

cp .env.local.example .env.local

Set each variable on .env.local:

  • MYSQL_HOST - Your MySQL host URL.
  • MYSQL_DATABASE - The name of the MySQL database you want to use.
  • MYSQL_USERNAME - The name of the MySQL user with access to database.
  • MYSQL_PASSWORD - The passowrd of the MySQL user.

Step 3. Run migration script

You'll need to run a migration to create the necessary table for the example.

npm run migrate
# or
yarn migrate

Step 4. 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.

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