Table of Contents

• Overview
• Features
• Getting Started
  • Prerequisites
  • Installation
• Project Roadmap
• Contributing
• License

Overview

Interactive or flag-driven CLI to Generates a new Next.js app with chosen options (app router vs pages, TypeScript setup). & developer tooling (ESLint, Prettier, Husky/Git hooks, commitlint, lint-staged). Creates initial README, .env.example, and helpful scripts in package.json. Optionally scaffolds common integrations: Tailwind, Prisma/Supabase, NextAuth, state libs (Redux/ Zustand), Storybook, i18n.

Features

Project Structure

└── Next-Repo-Init-CLI-Kit/
    ├── index.js
    ├── link_folder
    │   └── link.json
    ├── package-lock.json
    ├── package.json
    └── templates_collection

Getting Started

Installation

Install Next-Repo-Init-CLI-Kit using one of the following methods:

Build from source:

1. Clone the Next-Repo-Init-CLI-Kit repository:

❯ git clone https://github.com/HimanthaThathsara/Next-Repo-Init-CLI-Kit

Execute from Npm:

2. Install using NPM :

❯ cd Next-Repo-Init-CLI-Kit

Project Roadmap

• [X] Task 1: TypeScript strict config + helpful tsconfig references
• [ ] Task 2: Interactive CLI prompts + non-interactive flags next-init --name my-app --ts --tailwind --prisma
• [ ] Task 3: Husky + commitlint + conventional commits starter
• [ ] Task 4: Third-party plugins add features
• [ ] Task 5: Preset choices for App Router vs Pages Router
• [ ] Task 6: Edge functions/middleware and routing examples for edge runtime
• [ ] Task 7: Automatic dependency updates + security scans integration - Dependabot config + template for GitHub secret scanning

Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the Next-Repo-Init-CLI-Kit project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/HimanthaThathsara/Next-Repo-Init-CLI-Kit

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

License

This project is protected under the SELECT-A-LICENSE License. For more details, refer to the LICENSE file.