Skip to content

Commit

Permalink
Add local testing and linking guide
Browse files Browse the repository at this point in the history
  • Loading branch information
fritx committed Jan 15, 2024
1 parent 3cf395b commit ae2689b
Showing 1 changed file with 33 additions and 3 deletions.
36 changes: 33 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,36 @@ 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.yaml` 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
# if using bun
bun install
cd packages/nuekit
bun link
cd my/nue/project
nue
nue build --production

# if using node
npm install
cd packages/nuekit
npm link
cd my/nue/project
node $(which nue)
node $(which nue) build --production
```

0 comments on commit ae2689b

Please sign in to comment.