https://github.com/chaineasy/upgraded-sniffle
site
https://github.com/chaineasy/upgraded-sniffle
Last synced: 3 months ago
JSON representation
site
- Host: GitHub
- URL: https://github.com/chaineasy/upgraded-sniffle
- Owner: ChainEasy
- Created: 2023-07-08T20:12:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-13T04:45:30.000Z (6 months ago)
- Last Synced: 2025-01-09T03:45:22.351Z (5 months ago)
- Language: HTML
- Size: 223 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Deploying to GitHub Pages
This example supports deloying a statically exported Next.js application to GitHub Pages.
The `out` directory should not be ignored by version control.
## 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), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example:
```bash
npx create-next-app --example github-pages nextjs-github-pages
# or
yarn create next-app --example github-pages nextjs-github-pages
# or
pnpm create next-app --example github-pages nextjs-github-pages
```
### Deploy to GitHub Pages
1. Create a new public GitHub repository.
1. Edit `next.config.js` to match your GitHub repository name.
1. Push the starter code to the `main` branch.
1. Run the `deploy` script (e.g. `npm run deploy`) to create the `gh-pages` branch.
1. On GitHub, go to **Settings** > **Pages** > **Branch**, and choose `gh-pages` as the branch with the `/root` folder. Hit **Save**.
1. Make a change.
1. Run the `deploy` script again to push the changes to GitHub Pages.
Congratulations! You should have a URL like:
```bash
https://.github.io//
```