• Using the generator
• Folder Structure of generated projects
• Contributing to this project

This package includes the global command for creating new React projects incorporating Next.js, CICD pipelines, unit testing, quality gates, and code styling. It is useful for ensuring consistent working environments across multiple different applications.

Using

The Easy Way

1. Run npx create-amclin-nextjs-app or yarn create amclin-nextjs-app
2. Create a new empty repo in GitHub with the same project name
3. Push the new local commits up the new remote repo

The Hard Way

1. Clone this repo to a location on your local system
2. Navigate to the folder where you want to create a new project
3. Run node ../<path to the boilerplate>/index.js
4. Create a new empty repo in GitHub with the same project name
5. Push the new local commits up the new remote repo

Advanced Examples

Specify project name

Skip the prompt and specify the project name on the command line:

npx create-amclin-nextjs-app -- myprojectname

Skip Git repo generation

Skip the process of creating a git repo for the project. Note: this can result in failures as some of the dependencies expect git to be present:

npx create-amclin-nextjs-app --no-git

Assume Server-Side-Rendering (SSR)

Skip the question and assume the generated project will need server-side rendering:

npx create-amclin-nextjs-app --with-ssr

Environmental Configs (.env file)

The logic is located in next.config.js. You may use a .env file to provide environemntal variables, or you may use them from the commandline ENV_VARIABLE=X <your_command>.

Contributing

Help is always appreciated, please log bug reports, features, and fixes. See Contribution Guidelines for more on how you can help.