Create WI-Next-StarterKit

Quick start for WI-Next-StarterKit. Get up and running in one command.

Getting Started

Using npx

# Create with latest version
npx @workindia/create-next-starterkit new-site

# Create with specific version
npx @workindia/create-next-starterkit new-site --version 0.1.0

cd new-site
npm install
npm start

Using npm init

# Create with latest version
npm init @workindia/create-next-starterkit new-site

# Create with specific version
npm init @workindia/create-next-starterkit new-site --version 0.1.0

cd new-site
npm install
npm start

Using yarn

# Create with latest version
yarn create @workindia/create-next-starterkit new-site

# Create with specific version
yarn create @workindia/create-next-starterkit new-site --version 0.1.0

cd new-site
yarn install
yarn start

Requirements

npm: v5.2+ [Tested with node (23.6.1 & npm 10.9.2)]
If nvm is installed, simply run following to install & run appropriate node version.

nvm install
nvm use

CONTRIBUTING

Setting Up a Local Copy

1. Clone the repo with git clone https://github.com/workindia/create-wi-next-starterkit.git
2. Run npm install in the root create-wi-next-starterkit folder.
3. Run npm link to make npm run local copy instead of downloading from registry
4. Now you can use npm init @workindia/create-next-starterkit and npx @workindia/create-next-starterkit

note: you can use npx @workindia/create-next-starterkit ./out/example from create-wi-next-starterkit without running npm link also its possible to run directly NodeJS entry point node index.js ./out/example or npm start ./out is git ignored folder, so you should use this folder for tests.

If you want to try out the end-to-end flow with the global CLI, you can do this too:

npx @workindia/create-next-starterkit ./out/new-site
cd new-site
npm install
npm start

Tests

Tests are written using jest and located in tests/test.js

Run npm test
Run coverage reports npm run coverage

Develope & Publish

The package is published on public npm repository

1. Create Pull Request

   • Submit PR to the develop branch
   • Checklist before submission:
     • ✅ No sensitive data or credentials committed
     • ✅ CHANGELOG.md updated with changes
     • ✅ All tests passing (npm test)

2. Code Review

   • PR reviewed by maintainers
   • Address any feedback
   • Merge approved changes

3. Version Update

   • Maintainer updates:
     • CHANGELOG.md
     • package.json version
   • Merge changes to main

4. Tag Release

   chmod +x scripts/tag.sh
   .scripts/tag.sh

5. Create Release

   • Create new release on GitHub
   • Include release notes from CHANGELOG

6. Automated Publishing

   • GitHub Actions pipeline triggers automatically
   • Package published to npm registry