Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/planetscale/nextjs-starter
Next.js starter application using Prisma to connect to PlanetScale
https://github.com/planetscale/nextjs-starter
Last synced: 27 days ago
JSON representation
Next.js starter application using Prisma to connect to PlanetScale
- Host: GitHub
- URL: https://github.com/planetscale/nextjs-starter
- Owner: planetscale
- License: apache-2.0
- Created: 2022-01-24T18:52:11.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-02-03T21:05:09.000Z (10 months ago)
- Last Synced: 2024-08-03T13:04:12.289Z (4 months ago)
- Language: JavaScript
- Size: 625 KB
- Stars: 136
- Watchers: 6
- Forks: 48
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- Awesome-NextJs - nextjs-starter
README
# Next.js starter
This is a [Next.js](https://nextjs.org/) project that uses [Prisma](https://www.prisma.io/) to connect to a [PlanetScale](https://planetscale.com/) database and [Tailwind CSS](https://tailwindcss.com/) for styling.
## Prerequisites
- [Node.js](https://nodejs.org/en/download/)
- [PlanetScale CLI](https://github.com/planetscale/cli)
- Authenticate the CLI with the following command:
```sh
pscale auth login
```
## Set up the database
Create a new database with the following command:
```sh
pscale database create
```
> A branch, `main`, was automatically created when you created your database, so you can use that for `BRANCH_NAME` in the steps below.
## Set up the starter Next.js app
Clone the starter repository.
```sh
git clone https://github.com/planetscale/nextjs-starter
```
Install the dependencies.
```sh
npm install
```
Next, you'll need to create a database username and password through the CLI to connect to your application. If you'd prefer to use the dashboard for this step, you can find those instructions in the [Connection Strings documentation](/concepts/connection-strings#creating-a-password) and then come back here to finish setup.
First, create your `.env` file by renaming the `.env.example` file to `.env`:
```sh
mv .env.example .env
```
Next, using the PlanetScale CLI, create a new username and password for the branch of your database:
```sh
pscale password create
```
> The `PASSWORD_NAME` value represents the name of the username and password being generated. You can have multiple credentials for a branch, so this gives you a way to categorize them. To manage your passwords in the dashboard, go to your database overview page, click "Settings", and then click "Passwords".
Take note of the values returned to you, as you won't be able to see this password again.
```text
Password production-password was successfully created.
Please save the values below as they will not be shown again
NAME USERNAME ACCESS HOST URL ROLE PLAIN TEXT
--------------------- -------------- ----------------------------------- ------------------ -------------------------------------------------------
production-password xxxxxxxxxxxxx xxxxxx.us-east-2.psdb.cloud Can Read & Write pscale_pw_xxxxxxx
```
You'll use these properties to construct your connection string, which will be the value for `DATABASE_URL` in your `.env` file. Update the `DATABASE_URL` property with your connection string in the following format:
```text
mysql://:@/?sslaccept=strict
```
Push the database schema to your PlanetScale database using Prisma.
`npx prisma db push`
Run the seed script to populate your database with `Product` and `Category` data.
`npm run seed`
## Run the App
Run the app with following command:
`npm run dev`
Open your browser at [localhost:3000](localhost:3000) to see the running application.
## Deploying
After you've got your application running locally, it's time to deploy it. To do so, you'll need to promote your database branch (`main` by default) to be the production branch ([read the branching documentation for more information](https://planetscale.com/docs/concepts/branching)).
```sh
pscale branch promote
```
Now that your branch has been promoted to production, you can either use the existing password you generated earlier for running locally or create a new password. Regardless, you'll need a password in the deployment steps below.
Choose one of the following deploy buttons and make sure to update the `DATABASE_URL` variable during this setup process.
### Deploy on Vercel
[](https://vercel.com/new/clone?repository-url=https://github.com/planetscale/nextjs-starter&env=DATABASE_URL)
### Deploy on Netlify
\*Note: The `Netlify.toml` file in this repository includes the configuration for you to customize the `DATABASE_URL` property on the initial deploy.
[](https://app.netlify.com/start/deploy?repository=https://github.com/planetscale/nextjs-starter)
## Learn More
To learn more about PlanetScale, take a look at the following resources:
- [PlanetScale quick start guide](https://planetscale.com/docs/tutorials/planetscale-quick-start-guide) - Learn how to get started with PlanetScale.
## What's next?
Learn more about how PlanetScale allows you to make [non-blocking schema changes](https://planetscale.com/docs/concepts/nonblocking-schema-changes) to your database tables without locking or causing downtime for production databases. If you're interested in learning how to secure your application when connecting to PlanetScale,
please read [Connecting to PlanetScale securely](/reference/planetscale-security).
## Need help?
Get help from [PlanetScale's support team](https://www.planetscale.com/support), or join our [GitHub Discussion board](https://github.com/planetscale/beta/discussions) to see how others are using PlanetScale.