Skip to content

Commit 94298b2

Browse files
authored
chore: update readme with makefile commands (#599)
1 parent 8f9d343 commit 94298b2

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,11 +134,31 @@ const platform = new PlatformClient({
134134
Interceptors are particularly useful for scenarios where you need to dynamically modify requests, such as adding authentication tokens or logging request/response data.
135135

136136

137-
## Build and Test
137+
## Building and Testing
138+
139+
### Makefile Commands
140+
141+
The project provides a `Makefile` to simplify common development tasks. Below are the available commands:
142+
143+
| Command | Description |
144+
|-------------------|----------------------------------------------------------------------------------------------|
145+
| `make` | Builds and tests everything (default target). |
146+
| `make start` | Builds all packages and starts the web application in development mode. |
147+
| `make ci` | Installs dependencies and links the SDK package for all subprojects. |
148+
| `make i` | Installs dependencies and links the SDK package for all subprojects (without clean install). |
149+
| `make clean` | Removes build artifacts, packed files, and `node_modules` directories. |
150+
| `make cli` | Builds and packs the CLI tool. |
151+
| `make audit` | Runs `npm audit` for all packages except dev dependencies. |
152+
| `make format` | Runs code formatting for all packages. |
153+
| `make lint` | Runs linter for all packages. |
154+
| `make test` | Runs tests for all packages. |
155+
| `make license-check` | Checks license compliance for all packages. |
156+
| `make doc` | Generates documentation for the SDK. |
157+
| `make generate-platform` | Runs the platform code generation script. |
158+
| `make dist` | Copies the SDK package to the root directory. |
159+
160+
You can run any of these commands using `make <command>`.
138161

139-
```shell
140-
make
141-
```
142162

143163
## Contribute
144164

0 commit comments

Comments
 (0)