diff --git a/README.md b/README.md new file mode 100644 index 0000000..673b760 --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ + +# A Next.js + GitHub Pages stack + +NextJS logo plus sign GitHub Pages logo + +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).