cf-service-sdk 0.0.40 → 0.0.41
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/README.md +0 -53
package/package.json
CHANGED
package/README.md
DELETED
|
@@ -1,53 +0,0 @@
|
|
|
1
|
-
# Cloud Forge TypeScript SDK (cf-typescript-sdk)
|
|
2
|
-
|
|
3
|
-
## Local Setup Instructions
|
|
4
|
-
|
|
5
|
-
### 1. Clone the repository
|
|
6
|
-
If not already cloned:
|
|
7
|
-
```sh
|
|
8
|
-
git clone <repo-url>
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
### 2. Install Node.js
|
|
12
|
-
- Recommended: Node.js v18+
|
|
13
|
-
- [Download Node.js](https://nodejs.org/)
|
|
14
|
-
|
|
15
|
-
### 3. Install dependencies
|
|
16
|
-
```sh
|
|
17
|
-
npm install
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
### 4. Build the SDK
|
|
21
|
-
```sh
|
|
22
|
-
npm run build
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
### 5. (Optional) Generate code and update schema
|
|
26
|
-
If you need to update the GraphQL schema or regenerate SDK code:
|
|
27
|
-
```sh
|
|
28
|
-
npm run update-schema
|
|
29
|
-
npm run generate
|
|
30
|
-
npm run generate-sdk
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
### 6. Publish (if needed)
|
|
34
|
-
```sh
|
|
35
|
-
npm publish --access public
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
## Troubleshooting
|
|
41
|
-
- Ensure Node.js and npm are installed and in your PATH.
|
|
42
|
-
- If you use codegen, ensure any required backend services are running.
|
|
43
|
-
|
|
44
|
-
---
|
|
45
|
-
|
|
46
|
-
## Useful Commands
|
|
47
|
-
- Clean build: `./clean.sh`
|
|
48
|
-
- Test: `npm test`
|
|
49
|
-
|
|
50
|
-
---
|
|
51
|
-
|
|
52
|
-
## Contact
|
|
53
|
-
For issues, contact the repo maintainer.
|