Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pixelbrackets/open-source-profile

Self-Hosted profile page for your Open Source packages & contributions
https://github.com/pixelbrackets/open-source-profile

bitbucket github gitlab opensource php profile share

Last synced: 6 days ago
JSON representation

Self-Hosted profile page for your Open Source packages & contributions

Host: GitHub
URL: https://github.com/pixelbrackets/open-source-profile
Owner: pixelbrackets
Created: 2020-11-11T18:15:40.000Z (about 4 years ago)
Default Branch: development
Last Pushed: 2020-11-11T18:28:54.000Z (about 4 years ago)
Last Synced: 2025-01-19T20:18:17.047Z (6 days ago)
Topics: bitbucket, github, gitlab, opensource, php, profile, share
Language: PHP
Homepage: https://gitlab.com/pixelbrackets/open-source-profile
Size: 29.3 KB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

# Open Source Profile

[![Version](https://img.shields.io/packagist/v/pixelbrackets/open-source-profile.svg?style=flat-square)](https://packagist.org/packages/pixelbrackets/open-source-profile/)
[![Build Status](https://img.shields.io/gitlab/pipeline/pixelbrackets/open-source-profile?style=flat-square)](https://gitlab.com/pixelbrackets/open-source-profile/pipelines)
[![Made With](https://img.shields.io/badge/made_with-php-blue?style=flat-square)](https://gitlab.com/pixelbrackets/open-source-profile#requirements)
[![License](https://img.shields.io/badge/license-gpl--2.0--or--later-blue.svg?style=flat-square)](https://spdx.org/licenses/GPL-2.0-or-later.html)
[![Contribution](https://img.shields.io/badge/contributions_welcome-%F0%9F%94%B0-brightgreen.svg?labelColor=brightgreen&style=flat-square)](https://gitlab.com/pixelbrackets/open-source-profile/-/blob/master/CONTRIBUTING.md)

Self-Hosted profile page for your Open Source packages & contributions.

![Screenshot](./docs/screenshot.png)

## Vision

The general idea of this project is to have _one_ place with _all_ Open Source
packages and contributions of a person.

There are several platforms to host Open Source projects like GitHub, Gitlab,
Bitbucket, Sourceforge & Launchpad, and they all have fancy user profile pages.
They are isolated however. On BitBucket I can't showcase the one project I
maintain on GitLab only. The GitHub activity stream won't show contributions to
Launchpad. Let alone projects with self-hosted Git servers.

This creates a vendor lock-in. Which becomes obious when you search for
Open Source Software catalogues, contributions, or statistics. Most support
GitHub only.

Goals:

- List of all projects and packages of a person
- List of contributions of a person (issues, merge requests, commits)
- List of packages a person likes (starred projects)
- Highlight packages - Show most important projects at a glance
- Hide packages - Don't show the packages generated automatically by subsplits,
forks or mirrors
- Support for multiple Git hosting services (not just GitHub)
- Link mirrors - Git supports multiple remotes,
no need to limit to one repository host only
- Reduced UI (no platform specific buttons)

The package follows the KISS principle.

## 🚧 WIP

The package is only prototype right now, to go through the idea.

Next steps:

- Add a framework like Slim or Symfony and a template engine
- Add more metadata to projects and user
- Add a tool to initiate the project list
- Fetch contributions
- Fetch metadata (only overwrite fields like description)
- Make the output static (to deploy to Static Hosts)

## Requirements

- PHP

## Installation

Packagist Entry https://packagist.org/packages/pixelbrackets/open-source-profile/

- Point your webserver to the web directory
- Copy `data/projects.template.json` to `data/projects.json` and add links to
all your repositories
- Copy `data/user.template.json` to `data/user.json` and add your username

## Source

https://gitlab.com/pixelbrackets/open-source-profile/

Mirror https://github.com/pixelbrackets/open-source-profile/

## Demo

🚀 https://opensource.pixelbrackets.de/

## Usage

The `data` directory holds all necessary information to generate the view.

## License

GNU General Public License version 2 or later

The GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html.

## Author

Dan Untenzu ( / [@pixelbrackets](https://pixelbrackets.de))

## Changelog

See [./CHANGELOG.md](CHANGELOG.md)

## Contribution

This script is Open Source, so please use, patch, extend or fork it.

[Contributions](CONTRIBUTING.md) are welcome!