From bb827b03c4765ed4eba9e334b37229410b5cc1b0 Mon Sep 17 00:00:00 2001 From: Fritz Lin Date: Mon, 15 Jan 2024 12:43:44 +0800 Subject: [PATCH] Add local testing and linking guide --- CONTRIBUTING.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76ab4e40..650f2dfb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,6 +31,27 @@ Please try to use the original style in the codebase. Do not introduce new rules Nue is not using Prettier or ESLint because they will increase the project size to 40MB. The `.prettierrc.csj` file on the root directory does the job well enough. - - - +### Testing + +```sh +# if using bun +bun install +bun test +# if using node +npm install +npm install --global jest +node --experimental-vm-modules $(which jest) +``` + + +### Linking + +```sh +# node only +npm install +cd packages/nuekit +npm link +cd create-nue/simple-crm +node $(which nue) +node $(which nue) build --production +```