🦄 Sourcerer app makes a visual profile from your GitHub and git repositories.
A visual profile for software engineers.
Creating your profile is just the first step for us at Sourcerer. Some of the things on our roadmap include: * Engineers to follow and learn from * Technology and libraries you should know about * Projects that could use your help
The easiest way to get started is with your open source repos. Go to sourcerer.io/start, and select Build with GitHub and watch your profile build.
For closed source repos, you will need to use this app. If you already created an account using GitHub, you would have received an email with credentials for the app. If not, You will need a new account, which you can get at sourcerer.io/join.
git bashshould suffice)
To install sourcerer run the following command in bash:
curl -s https://sourcerer.io/app/install | bash
To run wizard use
sourcerercommand for macOS and Linux,
java -jar sourcerer.jarin folder
--helpfor additional info.
The app looks at repos locally on your machine, and then sends stats to sourcerer.io. The best way to verify is to look at the code. Protobuf messages declared in src/main/proto/sourcerer.proto is a good start as it describes the client-server protocol. The Sourcerer app does NOT upload source code anywhere, and it NEVER will.
We process only public repos using GitHub OAuth. To process private repos you need to run sourcerer app locally. See Get started for instructions. Sourcerer app sends only statistical information to our servers and never sends code.
We use emails to identify commit authorship, read orgs access to get list of public repositories that you've contributed to. You also need to grant access to read this public information from an organization.
We love contributions! Check out the Contribution guide for more information. Simplest and really helpful for the community would be contribution meta information to our supported libraries list. If you an author of a library you show definitely add yours to the list or you can help to someone whose work you use.
To build and run this application locally, you'll need latest versions of Git, Gradle and JDK installed on your computer. From your command line:
# Clone this repository $ git clone https://github.com/sourcerer-io/sourcerer-app.git
Go into the repository
$ cd sourcerer-app
$ gradle build
Run the app
$ java -jar build/libs/sourcerer-app.jar
Sourcerer is under the MIT license. See the LICENSE for more information.