Roche/the-ambassador

The Ambassador helps users of coding platforms to create findable, well maintained, properly documented and secure projects. It's purpose is to promote creating Open Source and InnerSource software, that others can rely on. It measures project scores (criticality, activity, scorecard), proactively advises projects.

Explore the docs »

Report a Bug · Request a Feature · Ask a Question

Table of Contents

• ✨ About
  • 💡 Motivation
  • 🔥 Features
  • 🚧 Built With
• 🚀 Getting Started
• ☁️ Deploying
• ⌨️️ Contributing
• 👨‍💻 👩‍💻 Contributors

✨ About

The Ambassador helps users of coding platforms to create findable, well maintained, properly documented and secure projects. It's purpose is to promote creating Open Source and InnerSource software, that others can rely on. It measures project scores (criticality, activity, scorecard), proactively advises projects and provides a handy API for querying indexed and rated projects.

💡 Motivation

• Automate analysis of quality posture of software projects
• Proactively notify projects' about potential improvements they can implement
• Help build a community of professionals openly sharing code
• Rate projects that are following good Open and InnerSource practices
• Discover dependencies between projects, packages, people and organizations

It is inspired by OSSF Security Scorecard, InnerSource Patterns and... life 😄

🔥 Features

• calculating projects' criticality, activity and security scores
• full text search of projects to easily find important and interesting projects
• indexing history, enabling users to see how their projects changed over time
• customizable indexing criteria
• handful API
• GitLab support
• authentication using OAuth2

More to come, including:

• advising projects through pull requests and issues how they can improve
• discovering dependency trees of software packages, contributors, collaborators and organizations
• multi-source support, allowing indexing projects from multiple coding platforms, including GitHub and Bitbucket
• give badges to projects
• webcomponents to easily embed projects search on your own page
• simple, standalone UI providing advanced search and visualization capabilities of indexed projects
• cloud-native deployment on Kubernetes

🚧 Built With

• Kotlin
• Spring Boot
• PostgreSQL
• jOOQ
• Gradle
• Docker

🚀 Getting Started

To be added soon...

☁️ Deploying

To be added soon...

⌨️️ Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

👨‍💻 👩‍💻 Contributors

Mateusz Filipowicz

WhiteSource Renovate