Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hubwriter authored Mar 7, 2022
1 parent 5b389a0 commit 2d40c2a
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@

# A Next.js + GitHub Pages stack

<img src="https://upload.wikimedia.org/wikipedia/commons/8/8e/Nextjs-logo.svg" alt="NextJS logo" width="100" height ="50"/> <img src="https://upload.wikimedia.org/wikipedia/commons/3/30/OCR-A_char_Plus_Sign.svg" alt="plus sign" width="40" height ="50"/> <img src="https://raw.githubusercontent.com/github/explore/80688e429a7d4ef2fca1e82350fe8e3517d3494d/collections/github-pages-examples/github-pages-examples.png" alt="GitHub Pages logo" width="50" height ="50" />

Use this stack to create a repository containing a [Next.js](https://nextjs.org)
web application that's deployed to [Github Pages](https://pages.github.com/).

## Why should you use this stack?
You can use this stack to create a preconfigured repository, complete with
a starter Next.js web application, and a live deployment, in just a few
minutes.

Next.js gives you a great developer experience with all the features you need
for production: hybrid static & server rendering, TypeScript support, smart
bundling, route pre-fetching and more. You can start coding straight away, and
view the deployed site without having to do any manual configuration.

This stack also sets up the repository, ready for you to get to work. It:
- Creates a `main` branch
- Creates repository topics
- Sets some branch rules
- Creates GitHub Actions workflows to provide CI/CD automation

## Required inputs
When you run this stack you will need to input:
- The version of Node.js you want to use. You can choose either `v12.22.4`
or `v14.17.4`.

## Github Apps installed with this stack
None

## Version summary
React version 17.0.2

## Deployment platform
GitHub Pages

## Viewing the deployment
After running this stack, on the Code page of your repository, under
"Environments", click **github-pages** then, on the Deployments page,
click **View deployment**.

## Learn more

### Next.js
Learn more about [Next.js](https://nextjs.org/learn).
Documentation: [https://nextjs.org/docs](https://nextjs.org/docs).

### Github Pages
Learn more about [Github Pages](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages).

0 comments on commit 2d40c2a

Please sign in to comment.