sourcerer-io/sourcerer-app
Sourcerer app makes a visual profile from your GitHub and git repositories.
| repo name | sourcerer-io/sourcerer-app |
| repo link | https://github.com/sourcerer-io/sourcerer-app |
| homepage | https://sourcerer.io/start |
| language | Kotlin |
| size (curr.) | 6905 kB |
| stars (curr.) | 5368 |
| created | 2017-07-07 |
| license | MIT License |
A visual profile for software engineers.
Features
- Profile creation with a single click
- Support of 100 languages (even exotic ones like COBOL)
- Detection of more than 1,000 libraries in code with per-line statistics
- Visual presentation your development experience
- Finally! Summary of all repositories you’ve contributed to :tada:
- Interesting facts about yourself
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
Get started
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.
Showcase
Requirements
- Web browser
or
- Linux or macOS or Windows
- Java 8+ Platform (JRE for Linux and Windows or JDK for macOS)
- Bash for Windows (
git bashshould suffice)
Usage
To install sourcerer run the following command in bash:
curl -s https://sourcerer.io/app/install | bash
To run wizard use sourcerer command for macOS and Linux, java -jar sourcerer.jar in folder Users\user\.sourcerer for Windows.
Use parameter --help for additional info.
Internals
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.
FAQ
How can I process private repos?
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.
Why do you need GitHub permissions?
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.
Other questions
See sourcerer.io/faq.
Contributing
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.
Build
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
# Build
$ gradle build
# Run the app
$ java -jar build/libs/sourcerer-app.jar
License
Sourcerer is under the MIT license. See the LICENSE for more information.
