Start with your public GitHub at https://sourcerer.io/start.
Once you feed Sourcerer some git repos, you will get a beautiful profile that will help you learn things about yourself, connect to others, and become a better engineer.
Example profiles:
https://sourcerer.io/sergey
https://sourcerer.io/ddeveloperr
https://sourcerer.io/wanghuaili
https://sourcerer.io/adnanrahic
Both open source and closed source repos are fine. The easiest way to get started is with your open source repos. Go to https://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 https://sourcerer.io/start, and select Build with app.
The Sourcerer app does NOT upload source code anywhere, and it NEVER will. 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. src/main/proto/sourcerer.proto is a good start as it describes the client-server protocol.
Creating your profile is just the first step for us at Sourcerer. Some of the things on our roadmap include:
- News that is relevant to your code
- Engineers to follow and learn from
- Technology and libraries you should know about
- Projects that could use your help
- Linux or macOS
- Java 8+ Platform (JRE for Linux or JDK for macOS)
- Git repositories with master branch with at least one commit
- Account on https://sourcerer.io/
To install sourcerer run the following command:
curl -s https://sourcerer.io/app/install | bash
To remove sourcerer from your machine:
sourcerer --uninstall
To build and run this application, 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
We love contributions! Check out the Contribution guide for more information.
Some handy links:
Sourcerer is under the MIT license. See the LICENSE for more information.