sourcerer-io/sourcerer-app: 🦄 Sourcerer app makes a visual profile from your GitHub and git repositories.

[kunpeng9]

A visual profile for software engineers.

软件工程师的可视化简介。

• Profile creation with a single click 单击创建配置文件
• Support of 100 languages (even exotic ones like COBOL) 支持 100 种语言 (即使是像 COBOL 这样的外来语言)
• Detection of more than 检测超过 1,000 libraries 1000 个图书馆 in code with per-line statistics 每行统计的代码
• Visual presentation your development experience 视觉展示你的开发经验
• Finally! 终于 Summary of all repositories you've contributed to 您贡献的所有存储库的摘要🎉
• Interesting facts about yourself 关于你自己的有趣事实

Creating your profile is just the first step for us at Sourcerer. Some of the things on our roadmap include:

创建你的个人资料只是我们在 Sourcerer 的第一步，我们路线图上的一些事情包括:

• 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.

最简单的开始方式是使用你的开源回购协议。进入 google sourcerer.io/start ，选择 Build with GitHub，然后观看你的个人资料的构建。

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.

对于闭源回购，你需要使用这个应用程序。如果你已经使用 GitHub 创建了一个账户，你就会收到一封邮件，里面有这个应用的凭证。如果没有，你将需要一个新的帐户，你可以在 sourcerer.io/join。

• Web browser 网页浏览器

or

或

• Linux or macOS or Windows 或者 macOS 或者 Windows
• Java 8+ Platform ( Java8 + 平台 (JRE for Linux and Windows or 适用于 Linux 和 Windows 或JDK for macOS) 为 macOS)
• Bash for Windows ( 为 Windows (git bash should suffice) 应足够)

To install sourcerer run the following command in bash:

要安装 sourcerer，请在 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.

要运行向导，可以使用 macOS 和 Linux 的 sourcerer 命令，在 Windows 的 Users user. sourcerer 文件夹中使用 java-jar sourceer.jar。

Use parameter --help for 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.

这个应用程序查看你机器上的本地回购信息，然后发送统计数据到 sourceer.io。验证的最佳方法是查看代码。在 src/main/proto/sourceer.proto 中声明的 Protobuf 消息是一个很好的开始，因为它描述了客户机 - 服务器协议。应用程序不会在任何地方上传源代码，也永远不会上传。

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.

我们只使用 GitHub OAuth 处理公共回购。要处理私人回购，你需要在本地运行 sourcerer 应用程序。请参阅 Get started 以获得说明。应用只向我们的服务器发送统计信息，从不发送代码。

Why do you need GitHub permissions? 为什么需要 GitHub 权限？

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.

参见 sourcerer.io/faq。

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:

要在本地构建和运行这个应用程序，您需要在计算机上安装最新版本的 Git、 Gradle 和 JDK。从您的命令行:

# 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

Sourcerer is under the MIT license. See the LICENSE for more information.

Sourcerer 使用 MIT 许可证。更多信息请参阅许可证。

• Sourcerer Site
• Sourcerer Blog
• Follow Sourcerer on Twitter
• Follow Sourcerer on Facebook https://github.com/sourcerer-io/sourcerer-app