You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Once you feed [Sourcerer](https://sourcerer.io/) some git repos, you will get a beautiful profile that will help you learn things about yourself, connect to others, and become a better
18
-
engineer.
19
-
20
-
Example profiles:<br>
21
-
<https://sourcerer.io/sergey><br>
22
-
<https://sourcerer.io/ddeveloperr><br>
23
-
<https://sourcerer.io/wanghuaili><br>
24
-
<https://sourcerer.io/adnanrahic><br>
25
-
26
-
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](https://github.com/sourcerer-io/sourcerer-app/blob/develop/src/main/proto/sourcerer.proto)
29
-
is a good start as it describes the client-server protocol.
18
+
Features
19
+
========
20
+
* Profile creation with a single click
21
+
* Support of 100 languages (even exotic ones like COBOL)
22
+
* Detection of more than [1,000 libraries](https://github.com/sourcerer-io/awesome-libraries) in code with per-line statistics
23
+
* Visual presentation your development experience
24
+
**Finally!* Summary of all repositories you've contributed to :tada:
25
+
* Interesting facts about yourself
26
+
*:radio: News channels that are relevant to your code
30
27
31
28
Creating your profile is just the first step for us at Sourcerer. Some of the things on our roadmap include:
32
-
* News that is relevant to your code
33
29
* Engineers to follow and learn from
34
30
* Technology and libraries you should know about
35
31
* Projects that could use your help
36
32
33
+
Get started
34
+
===========
35
+
The easiest way to get started is with your open source repos. Go to [sourcerer.io/start](https://sourcerer.io/start), and select *Build with GitHub* and watch your profile build.
36
+
37
+
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](https://sourcerer.io/join>).
* Java 8+ Platform ([JRE](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) for Linux or [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) for macOS)
43
-
* Git repositories with master branch with at least one commit
44
-
* Account on <https://sourcerer.io/>
62
+
or
45
63
46
-
Install/uninstall
47
-
=================
64
+
* Linux or macOS or Windows
65
+
* Java 8+ Platform ([JRE](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) for Linux and Windows or [JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) for macOS)
48
66
67
+
Usage
68
+
=====
49
69
To install sourcerer run the following command:
50
70
51
71
```
52
72
curl -s https://sourcerer.io/app/install | bash
53
73
```
54
74
55
-
To remove sourcerer from your machine:
75
+
To run wizard use `sourcerer` command
56
76
57
-
```
58
-
sourcerer --uninstall
59
-
```
77
+
Internals
78
+
=========
79
+
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](https://github.com/sourcerer-io/sourcerer-app/blob/develop/src/main/proto/sourcerer.proto) is a good start as it describes the client-server protocol.
80
+
The Sourcerer app does **NOT** upload source code anywhere, and it **NEVER** will.
81
+
82
+
FAQ
83
+
===
84
+
### How can I process private repos?
85
+
We process only public repos using GitHub OAuth. To process private repos you need to run sourcerer app locally. See [Get started](#get-started) for instructions. Sourcerer app sends only statistical information to our servers and never sends code.
86
+
87
+
### Why do you need GitHub permissions?
88
+
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.
89
+
90
+
### Other questions
91
+
See [sourcerer.io/faq](https://sourcerer.io/faq).
92
+
93
+
Contributing
94
+
============
95
+
We love contributions! Check out the [Contribution guide](https://github.com/sourcerer-io/sourcerer-app/blob/master/CONTRIBUTING.md) for more information. Simplest and really helpfull for the community would be contribution meta information to our [supported libraries list](https://github.com/sourcerer-io/awesome-libraries). 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.
60
96
61
97
Build
62
98
=====
63
-
64
-
To build and run this application, you'll need latest versions of Git, Gradle and JDK installed on your computer. From your command line:
99
+
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:
65
100
66
101
```
67
102
# Clone this repository
@@ -77,17 +112,13 @@ $ gradle build
77
112
$ java -jar build/libs/sourcerer-app.jar
78
113
```
79
114
80
-
Contributing
81
-
============
82
-
83
-
We love contributions! Check out the [Contribution guide](https://github.com/sourcerer-io/sourcerer-app/blob/master/CONTRIBUTING.md) for more information.
115
+
License
116
+
=======
117
+
Sourcerer is under the MIT license. See the [LICENSE](https://github.com/sourcerer-io/sourcerer-app/blob/develop/LICENSE.md) for more information.
84
118
85
-
Some handy links:<br>
119
+
Links
120
+
=====
86
121
*[Sourcerer Site](https://sourcerer.io/)
87
122
*[Sourcerer Blog](https://blog.sourcerer.io)
88
123
*[Follow Sourcerer on Twitter](https://twitter.com/sourcerer_io)
89
124
*[Follow Sourcerer on Facebook](https://www.facebook.com/sourcerer.io/)
90
-
91
-
License
92
-
=======
93
-
Sourcerer is under the MIT license. See the [LICENSE](https://github.com/sourcerer-io/sourcerer-app/blob/develop/LICENSE.md) for more information.
0 commit comments