Skip to content

Commit

Permalink
Updated contributing guide (#316)
Browse files Browse the repository at this point in the history
  • Loading branch information
ntotten authored Nov 4, 2024
1 parent c66cc84 commit 85a44c8
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 8 deletions.
7 changes: 1 addition & 6 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,7 +1,2 @@
LOG_LEVEL=debug
ZUDOKU_INTERNAL_DEV=true


# NX Cloud
# For Zuplo team members only (not needed for external contributors)
NX_CLOUD_ACCESS_TOKEN="op://Development/nx-cloud-access-tokens/zudoku-dev"
ZUDOKU_INTERNAL_DEV=true
2 changes: 1 addition & 1 deletion .tool-versions
Original file line number Diff line number Diff line change
@@ -1 +1 @@
nodejs 20.17.0
nodejs 20.18.0
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@ To install nx globally run:
pnpm add --global nx@latest
```

## Environment Variables

When working on Zudoku, you will need to create a `.env` file in the root of the project and set the following environment variable in order to run the project locally.

```
ZUDOKU_INTERNAL_DEV=true
```

## NX Cache

If you are a Zuplo employee you should authenticate to NX Cloud in order to use the build cache.

To authenticate run:

```
nx login
```

## Build

To build all projects run:
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"clean": "git clean -Xfde !.env",
"prepare": "husky",
"release:pre": "gh workflow run release.yaml -f releaseType=prerelease",
"release:minor": "gh workflow run release.yaml -f releaseType=minor"
"release:minor": "gh workflow run release.yaml -f releaseType=minor",
"local": "cp .env.example .env"
},
"lint-staged": {
"**/*.{ts,tsx,json,md,yml,js,jsx,css,html}": [
Expand Down

0 comments on commit 85a44c8

Please sign in to comment.