https://github.com/kyso-io/kyso-api

https://github.com/kyso-io/kyso-api

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kyso-io/kyso-api
• Owner: kyso-io
• License: gpl-3.0
• Created: 2023-09-19T15:03:02.000Z (about 1 year ago)
• Default Branch: develop
• Last Pushed: 2023-09-28T10:22:01.000Z (about 1 year ago)
• Last Synced: 2024-06-21T12:27:09.780Z (5 months ago)
• Language: TypeScript
• Size: 28.5 MB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Governance: docs/governance-doc.md

Awesome Lists containing this project

• awesome-starred - kyso-io/kyso-api - (others)

README

        
![Vulnerabilities](https://dtrack.dev.kyso.io/api/v1/badge/vulns/project/65224de0-11be-47c2-a319-d25373034b60)

![Policy violations](https://dtrack.dev.kyso.io/api/v1/badge/violations/project/65224de0-11be-47c2-a319-d25373034b60)

# Kyso API

## .env

| Property                        | Description                                                                            | Mandatory | Example |

|---------------------------------|----------------------------------------------------------------------------------------|-----------|---------|

| DATABASE_URI                    | Database URI to connect to                                                             |     X     | mongodb://{{user}}:{{password}}@localhost:27017/kyso?retryWrites=true&w=majority        |

| POPULATE_TEST_DATA              | True if you want to populate with testing data, false if not. **Default value false**  |           | true        |

| POPULATE_TEST_DATA_MAIL_PREFIX  | Populate test data mail prefix. **Default value: lo**                                  |           | dev       |

| PORT                            | Exposed API port. **Default value: 4000**                                              |           | 4000        |

| APP_MOUNT_DIR                   | Specific route to mount the API. **Default value: empty**                              |           | api        |

## .vscode/launch.json for debugging

```json

{

    "version": "0.2.0",

    "configurations": [

      {

        "type": "node",

        "request": "attach",

        "name": "Attach NestJS WS",

        "port": 9229,

        "restart": true,

        "stopOnEntry": false,

        "protocol": "inspector"

      }

    ]

}

```

# .env