bed476517c
This commit integrates an bare skeleton of the odyssey frontend that we implemented in the [odyssey-hackathon] repository. You can see the working frontend that we are trying to port over at [sourcecred.io/odyssey-hackathon/][scio]. The prototype in the other repository has some tooling choices which are incompatible/redundant with decisions in our codebase (sass vs aphrodite), and requires some tools not yet present here (svg-react-loader). This commit includes the build and integration work needed to port the prototype frontend into mainline SourceCred. The frontend scaffold isn't yet integrated with any "real" Odyssey data. One potential issue: right now, every page that is rendered from the SourceCred homepage is contained within a [homepage/Page], meaning that it has full SourceCred website styling, along with the SourceCred website header. The [application][scio] also has a header. Currently, I work around this by having the Odyssey UI cover up the base header (via absolute positioning), which works but is hacky. We can consider more principled solutions: - Finding a way to specify routes which aren't contained by [homepage/Page]; maybe by adding a new top-level route [here][route-alternative]. - Unify the headers for the Odyssey viewer and the page as a whole (sounds like inappropriate entanglement?) - Have a website header and also an application header (sounds ugly?) [homepage/Page]: |
||
|---|---|---|
| .circleci | ||
| config | ||
| flow-typed/npm | ||
| scripts | ||
| sharness | ||
| src | ||
| .eslintrc.js | ||
| .flowconfig | ||
| .gitignore | ||
| .mailmap | ||
| .prettierignore | ||
| .prettierrc.json | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| LICENSE-APACHE | ||
| LICENSE-MIT | ||
| README.md | ||
| package.json | ||
| yarn.lock | ||
README.md
SourceCred
SourceCred creates reputation networks for open-source projects. Any open-source project can create its own cred, which is a reputational metric showing how much credit contributors deserve for helping the project. To compute cred, we organize a project’s contributions into a graph, whose edges connect contributions to each other and to contributors. We then run PageRank on that graph.
To learn more about SourceCred’s vision and values, please check out our website and our forum. One good forum post to start with is A Gentle Introduction to Cred.
For an example of SourceCred in action, you can see SourceCred’s own prototype cred attribution.
Current Status
We have a prototype that can generate a cred attribution based on GitHub interactions (issues, pull requests, comments, references, etc.). We’re working on adding more information to the prototype, such as tracking modifications to individual files, source-code analysis, GitHub reactions, and more.
Running the Prototype
If you’d like to try it out, you can run a local copy of SourceCred as follows. First, make sure that you have the following dependencies:
- Install Node (tested on v8.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.
Then, 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
node bin/sourcecred.js load REPO_OWNER/REPO_NAME
# this loads sourcecred data for a particular repository
# it can take a few mins to run and will exit when finished
yarn start
# then navigate to localhost:8080 in your browser
For example, if you wanted to look at cred for ipfs/js-ipfs, you could run:
$ export SOURCECRED_GITHUB_TOKEN=0000000000000000000000000000000000000000
$ node bin/sourcecred.js load ipfs/js-ipfs
replacing the big string of zeros with your actual token.
You can also combine data from multiple repositories into a single graph.
To do so, pass multiple repositories to the load command, and specify an “output name” for the repository.
For instance, the invocation
node bin/sourcecred.js load ipfs/js-ipfs ipfs/go-ipfs --output ipfs/meta-ipfs
will create a graph called ipfs/meta-ipfs in the cred explorer, containing the combined contents of the js-ipfs and go-ipfs repositories.
Early Adopters
We’re looking for projects who want to be early adopters of SourceCred! If you’re a maintainer of an open-source project and would like to start using SourceCred, please reach out to us on our Discord or our forum.
Contributing
We’d love to accept your contributions! You can reach out to us by posting on our forum, or chatting with us on Discord. We'd be happy to help you get started and show you around the codebase. Please also take a look at our contributing guide.
If you’re looking for a place to start, we’ve tagged some good first issues.
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. We’d also like to thank the many open-source communities that produced the software that SourceCred is built on top of, such as Git and Node.