Jam3 NextJS Generator

Boilerplate for React, Static and Server Side Rendered projects with NextJS

https://generator.jam3.net

Icon made by Pixel perfect from www.flaticon.com

---

Table of Contents

• Installation
• Usage
• Release
• Contributing
• License

Installation

Clone the GitHub repository or Fork it, and start working righ away with it.

git clone https://github.com/Jam3/nyg-nextjs.git

Set up CI/CD

Deploying a static site is fairly simple, we are going to the set up for Codeship.

1. Create env variables with AWS Access Keys

Create three environment variables based on .env.codeship.[env].local.example

Files:

• .env.codeship.dev.local
• .env.codeship.stage.local
• .env.codeship.prod.local

Note: The environment variable files can't be commited. Based on the name convention they are ignored by GIT.

2. Generate encrypted env variables

Run $ ./encrypt-env.sh

3. Update S3 and Cloudfront environment variables in codeship-services.yml

Update S3_ORIGIN_BUCKET and DISTRIBUTION_ID with your AWS information.

4. Create a Codeship Pro project in Codeship

Usage

TBD: List commands in package.json

Release

To releasing new versions we are using standard-version.

Steps:

1. When PRs/commits land to your master branch, select the Squash and Merge option.
2. Add a title and body that follows the Conventional Commits Specification.
3. Run $ git checkout master; git pull origin master
4. Run $ npm run release
5. Run $ git push --follow-tags origin master

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

License

MIT