Merge pull request #1 from KusionStack/api-sdk

feat: add kusion server API client and SDKs

Author: Yangyang96

.eslintignore

@@ -0,0 +1,10 @@
+# Build outputs
+dist/
+docs/
+
+# Dependencies
+node_modules/
+
+# Generated files
+*.gen.ts
+*.gen.js

.eslintrc.js

@@ -0,0 +1,9 @@
+module.exports = {
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+};

.github/workflows/docs.yml

@@ -0,0 +1,19 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**'
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@4.1.4
+        with:
+          branch: gh-pages
+          folder: docs

.gitignore

@@ -0,0 +1,8 @@
+**/yarn.lock
+**/package-lock.json
+# Dependencies
+node_modules/
+**/node_modules/
+# Build outputs
+dist/
+

.npmignore

@@ -0,0 +1,29 @@
+# Source
+src/
+examples/
+openapi-ts.config.ts
+
+# Config files
+.eslintrc
+.eslintignore
+tsconfig.json
+tsconfig.build.json
+typedoc.json
+
+# Development files
+.github/
+docs/
+api/
+CLA.md
+
+# Git files
+.git/
+.gitignore
+
+# Dependencies
+node_modules/
+yarn.lock
+package-lock.json
+
+# Only include dist folder for npm package
+!dist/

README.md

@@ -1,20 +1,70 @@
-# .github
+# Kusion API Client SDK
 
-* [Overview](#overview)
-* [GitHub files](#github-files)
-* [Contributing](#contributing)
+A TypeScript SDK for interacting with the Kusion Server API.
 
-## Overview
+## Installation
 
-This repository stores
-[default GitHub template files](https://help.github.com/en/articles/creating-a-default-community-health-file-for-your-organization).
-These files apply to all other KusionStack repositories that do not have
-their own versions in their `.github/` directory.
+Using npm:
+```bash
+npm install @kusionstack/kusion-api-client-sdk
+```
 
-## GitHub files
+Using yarn:
+```bash
+yarn add @kusionstack/kusion-api-client-sdk
+```
 
-See [our `.github` documentation](.github/README-templates.md).
+## Quick Start
+
+```typescript
+import { client, SourceService } from '@kusionstack/kusion-api-client-sdk';
+
+// Configure the client
+client.setConfig({
+    baseUrl: 'http://localhost:80'
+});
+
+// Use the SDK
+async function example() {
+    try {
+        const sources = await SourceService.listSource();
+        console.log('Sources:', sources.data);
+    } catch (error) {
+        console.error('Error:', error);
+    }
+}
+```
+
+## Features
+
+- 🔒 Type-safe API interactions
+- 🚀 Promise-based async operations
+- ⚡️ Modern TypeScript support
+- 🛠 Built-in error handling
+
+## Documentation
+
+Visit our [API documentation](https://kusionstack.github.io/kusion-typescript-sdk/)
+For examples, please refer to:
+
+- [Example Usage](examples/)
 
 ## Contributing
 
-See [the contributing document](CONTRIBUTING.md).
+We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.
+
+## License
+
+This project is licensed under the [Apache License 2.0](LICENSE).
+
+## Support
+
+If you encounter any issues or have questions:
+- Open an [issue](https://github.com/KusionStack/kusion/issues)
+- Join our community discussions
+- Check our [documentation](docs/)
+
+## Related Projects
+
+- [Kusion](https://github.com/KusionStack/kusion) - The main Kusion project
+- [KusionStack](https://github.com/KusionStack) - The KusionStack organization