https://github.com/saagie/sdk

Saagie 📦 SDK for Technologies
https://github.com/saagie/sdk

Last synced: 7 days ago
JSON representation

Saagie 📦 SDK for Technologies

• Host: GitHub
• URL: https://github.com/saagie/sdk
• Owner: saagie
• License: apache-2.0
• Created: 2020-03-10T09:34:17.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-02-13T09:43:18.000Z (almost 2 years ago)
• Last Synced: 2024-08-10T21:29:22.197Z (5 months ago)
• Language: JavaScript
• Homepage: https://www.saagie.com/
• Size: 1.26 MB
• Stars: 2
• Watchers: 12
• Forks: 5
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Saagie 📦 SDK for Technologies

[![build](https://img.shields.io/github/workflow/status/saagie/sdk/Master%20Build)][build]

[![npm](https://img.shields.io/npm/v/@saagie/sdk)][npm]

[build]: https://github.com/saagie/sdk/actions?query=workflow%3A%22Master+Build%22

[npm]: https://www.npmjs.com/package/@saagie/sdk

The **Saagie Technology SDK** allows you to implements **new technologies** easily within the [Saagie](https://www.saagie.com/) platform.

---

## Requirements

* **[Node.js](https://nodejs.org/)** - Minimum version: `16`

---

## 🤩 Create your first technology

### 👉 Initialize your technology

```sh

npx @saagie/sdk init

```

If it does not work (`npx` is a little capricious on system with space in the path) go to the folder where you want your technology to be located:

```sh

npm init -y

npm install @saagie/sdk

```

Update the `package.json` to include this script command :

```json

{

  "...": "...",

  "scripts": {

    "init": "saagie-sdk init"

  },

  "...": "..."

}

```

Now run to start the technology prompt:

```sh

npm run init

```

### 👉 Run your technology locally

```sh

npm run dev

```

### 👉 Build your technology

```sh

npm run build

```

### 👉 Create a new context

```sh

npm run new:context

```

---

## 📚 Technologies & Contexts documentation

**[▶️ Access the SDK documentation](https://saagie.zendesk.com/hc/en-us/articles/360013330039-Create-and-manage-technologies)**

Quick links:

* [📚 technology.yaml](https://saagie.zendesk.com/hc/en-us/articles/360013330039-Create-and-manage-technologies#_attributes)

* [📚 context.yaml](https://saagie.zendesk.com/hc/en-us/articles/360013330039-Create-and-manage-technologies#external-tech)

---

## 💻 CLI Commands

```

Usage: saagie-sdk [options] [command]

Options:

  -V, --version    output the version number

  -h, --help       display help for command

Commands:

  init             Create an empty Saagie External Technology project

  start [options]  Run local application

  build            Package your technology

  help [command]   display help for command

```

---

## 👩‍👨‍ Contributing

Please read our [Contributing Guide](./CONTRIBUTING.md) before submitting a Pull Request to the project.