Skip to content

Commit

Permalink
added docs for building the secret-scan, schema, and api-client packa…
Browse files Browse the repository at this point in the history
…ge, also added a single build command to build all the three packages at once
  • Loading branch information
poswalsameer committed Feb 8, 2025
1 parent 86b2a0b commit d939a02
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/contributing-to-keyshade/setting-things-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,34 @@ To install the dependencies, run the following command:
pnpm install
```

## Building all the required packages

To make sure all the things work fine, build all these packages by running the following commands:

- Build the secret-scan package:

```bash
pnpm build:secret-scan
```

- Build the schema:

```bash
pnpm build:schema
```

- Build the api-client:

```bash
pnpm build:api-client
```

Or, want to save your precious time? Run all three commands in one go by running this command:

```bash
pnpm build:packages
```

## Installing Turbo

The final step involves installing our monorepo management tool. We have transitioned to using Turbo to streamline our development process. To install Turbo, run the following command:
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,7 @@
"build:api-client": "pnpm build:schema && turbo run --filter=@keyshade/api-client build",
"build:schema": "turbo run build --filter=@keyshade/schema",
"build:secret-scan": "turbo run build --filter=@keyshade/secret-scan",
"build:packages": "pnpm build:schema && turbo run --filter=@keyshade/api-client build && turbo run build --filter=@keyshade/secret-scan",
"start": "turbo run start",
"start:api": "turbo run start --filter=@keyshade/api",
"start:web": "turbo run start --filter=@keyshade/web",
Expand Down

0 comments on commit d939a02

Please sign in to comment.