How to add your Project

You can include your open source project to TangleGuard Cloud for free.

That is an offer from Archwise Solutions. The goal is the be ale to easily browser the structures of open source software, to be able to evaluate the quality of that piece of software.

It's also a great way to get into a new open source project. Understanding the architecture of a projects at it glance can help you get started quickly. That way, the whole community profits.

Create a API key

The usage of TangleGuard Cloud is free for open source projects. However you need to have an API key, so you can edit the project from your account.

Log in to TangleGuard Cloud and create an account. Once you're logged in, you can create an API key from your profile settings.

Set up the GitHub Action

The integration is possible via a GitHub Action. It's also available on the GitHub Marketplace. This Action provides a couple of functionalities. Here, we only need one bit of it, the upload functionality. It's also explained in this README section.

Below you see the whole Action configuration.

name: TangleGuard Upload
on:
    push:
        branches:
            - main
jobs:
    upload-code-architecture:
        runs-on: ubuntu-latest
        steps:
        - uses: TangleGuard/github-action@main
            with:
            upload_results: "true"
            description: "A tool that..."
            language: "rust" # Required to specify the scanner

Browse your Architecture

The action extract the relevant information and uploads it to the TangleGuard Cloud. It get's listed on the front page and is accessible via the following URL: