Clone the repository:
git clone [email protected]:blomqma/next-rest-framework.git
Install dependencies:
pnpm i
Build the next-rest-framework
package:
pnpm run build
Run the development Next.js project:
pnpm run dev
To test your changes in the next-rest-framework
package against the dev project, simply rebuild the package with pnpm run build
and the changes will be synced automatically.
Run unit tests:
pnpm run test
Run unit tests in watch mode:
pnpm run test:watch
Run formatting:
pnpm run format
Run linting:
pnpm run lint
All documentation is in README.md, please update that when needed.
All pull requests are welcome and done against the main
branch, please write tests for all changes, write documentation when needed and use descriptive commit messages. No need to update the changelog.
By contributing, you agree to license your contribution under the LICENSE.