https://github.com/piszmog/oss-facts
🔎 Determine whether open-source software is friendly to use.
https://github.com/piszmog/oss-facts
open-source oss ui
Last synced: about 2 months ago
JSON representation
🔎 Determine whether open-source software is friendly to use.
- Host: GitHub
- URL: https://github.com/piszmog/oss-facts
- Owner: Piszmog
- License: mit
- Created: 2022-02-06T02:49:17.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-27T10:16:26.000Z (over 2 years ago)
- Last Synced: 2025-02-12T14:38:46.879Z (3 months ago)
- Topics: open-source, oss, ui
- Language: TypeScript
- Homepage: https://oss-facts.vercel.app
- Size: 688 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OSS Facts
🔎 A dashboard to determine if Open Source Software (OSS) is friendly to use.
Visit [oss-facts](https://oss-facts.vercel.app/) to determine if certain Open Source Software (OSS) is friendly to use.
## Why?
When building a library, an application, or a framework, there is a good chance you will be depending on Open Source
Software (OSS). But not all OSS is friendly to use. The licensing of the OSS needs to be evaluated to determine if it is
friendly to what you are building. Before use OSS, you also need to determine if there are any open security advisories.
To help determine if OSS is friendly to use, this dashboard will help with providing this information in an
easy-to-understand way.
## What is determined friendly?
### Licensing
*OSS Facts* approaches the licensing in an **opinionated** way (not everyone will agree).
Any license that is "viral" (e.g. GNU, Mozilla 2.0) or forces source code to be disclosed is considered "not friendly"
to use. The reasoning is that not everyone building software will want to disclose their source code nor be forced to
use a certain license.
*OSS Facts* will simply make you aware of the risks of using OSS that has a "not friendly" license.
### Security
Any OSS that has any Security Advisories is not considered friendly to use. You need to check the OSS page to determine
if the vulnerability are acceptable to you.
## How to share OSS choices?
### CSV
*Not available on mobile*
The dashboard has a nifty button that will download the OSS that you have added to a CSV file. This will help make is
easier to share what software you want to use. If you operate in a process heavy environment, this file will be helpful
with any requests or process you need to go thru.
See [oss.csv](./oss.csv) for an example of the CSV file.
A CSV can be imported back into the dashboard to view the selected OSS.
### Dashboard URL
The `Copy` Button will copy the URL of the dashboard to your clipboard. This allows the dashboard to be shared with
anyone.
For example,
see [oss-facts dashboard](https://oss-facts.vercel.app/?names=Y2hha3JhLXVpL2NoYWtyYS11aSxlbW90aW9uLWpzL2Vtb3Rpb24sZnJhbWVyL21vdGlvbix6ZW1pcmNvL2pzb24yY3N2LHZlcmNlbC9uZXh0LmpzLG5vZGUtZmV0Y2gvbm9kZS1mZXRjaCxvY3Rva2l0L29jdG9raXQuanMsZmFjZWJvb2svcmVhY3QsbWljcm9zb2Z0L1R5cGVTY3JpcHQsZXNsaW50L2VzbGludA==)
## Dashboard Example
Below is a screenshot of all the OSS that this application uses.
