84c9122a2a
This commit removes the old homepage entirely. This is a prelude to removing the react-router dependency, which is needed to unblock work on the initiatives editor. Because the homepage is gone, there's now no frontend included with SourceCred. As such, we should merge #1873 alongside this one, so that our README doesn't give any patently false information to our users. Test plan: `yarn test` passes. `yarn start` and `yarn build` are no longer commands. (`yarn start2` and `yarn build2` will be renamed later).
SourceCred
SourceCred allows communities to assign Cred scores, which measure the value that contributors have brought to the community. The community can then use the scores to distribute rewards (e.g. project-specific Grain tokens) to their contributors.
Cred is computed by constructing a Cred Graph showing every contribution to a project, and then running a version of the PageRank algorithm to assign scores to every contribution and contributor.
We currently support loading data from GitHub, Discourse, Discord, and via custom "initiatives".
Please check out our website for more information. If you'd like to get involved as a contributor, please drop by our Discord and say "hi"!
Current Status
SourceCred is still in beta; as such, the interfaces are in flux and the documentation is spotty. We're working on a polished release which will include more documentation, and more maintainable instances. We expect this to land by early July.
For now, if you want to use SourceCred, you might start by forking MetaGame's Cred Instance.
Note that our next release (v0.7.0) will totally revamp how SourceCred instances are setup, and replace the CLI. As such, expect that migrating from v0.6.0 to v0.7.0 will involve making changes to your configuration.
Development Setup
- Install Node (tested on v12.x.x and v10.x.x).
- Install Yarn (tested on v1.7.0).
- Create a GitHub API token. No special permissions are required.
- For macOS users: Ensure that your environment provides GNU coreutils. See this comment for details about what, how, and why.
You'll still need to create a GitHub token to use as an environment variable (shown later). First, run the following commands to clone and build SourceCred:
git clone https://github.com/sourcecred/sourcecred.git
cd sourcecred
yarn install
yarn backend
export SOURCECRED_GITHUB_TOKEN=YOUR_GITHUB_TOKEN
Once that's been setup, you can start running SourceCred development commands. In master, the commands are currently in flux. This README will be updated when we have a stable CLI again.
License
SourceCred is dual-licensed under Apache 2.0 and MIT terms:
- Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
- MIT License (LICENSE-MIT or https://opensource.org/licenses/MIT)
Acknowledgements
We’d like to thank Protocol Labs for funding and support of SourceCred.