First off, thanks for your help!
- Fork and clone the repository
- Install dependencies with
pnpm install - Start the development environment with
pnpm dev
This monorepo contains:
- The source code for the
nuqsNPM package, inpackages/nuqs. - A Next.js app under
packages/docsthat serves the documentation and as a playground deployed at https://nuqs.47ng.com - A test bench for end-to-end tests driven by Cypress
When running next dev, this will:
- Build the library and watch for changes using
tsup - Start the docs/playground, which will be available at http://localhost:3000.
- Start the end-to-end test bench, which will be available at http://localhost:3001.
You can run the complete integration test suite with pnpm test.
It will build the library, run unit tests and typing tests against it, and then run the end-to-end tests against the test bench Next.js app (which uses the built library).
When proposing changes or showcasing a bug, adding a minimal reproduction in the playground can be very helpful.
Please follow the issue template when opening a new issue.
A minimal reproduction example is very helpful to understand the issue and inspect it locally.
This repository uses semantic-release
to automatically publish new versions of the package to NPM.
To do this, the Git history follows the
Conventional Commits format.