Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colemars/devcontra-api
Contribution aggregation tool hooked up to aws via serverless framework
https://github.com/colemars/devcontra-api
Last synced: 8 days ago
JSON representation
Contribution aggregation tool hooked up to aws via serverless framework
- Host: GitHub
- URL: https://github.com/colemars/devcontra-api
- Owner: colemars
- License: mit
- Created: 2019-08-08T04:37:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-08-03T13:26:41.000Z (over 3 years ago)
- Last Synced: 2024-12-24T16:53:51.786Z (12 days ago)
- Language: JavaScript
- Homepage:
- Size: 42.8 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.MD
- License: LICENSE
Awesome Lists containing this project
README
DevContra
[React](https://reactjs.org/) component that implements [d3](https://github.com/d3/d3) for data visualization and is configured via the [DevContra Client](https://prod-devcontra.now.sh).
[](https://www.npmjs.com/package/devcontra)
[](https://www.npmjs.com/package/devcontra)
[](https://twitter.com/itsacolemars)
[](https://dependabot.com)
[](https://david-dm.org/colemars/devcontra-component?type=peer)
[](https://david-dm.org/colemars/devcontra-component)
[](https://david-dm.org/colemars/devcontra-component?type=dev)
[](https://isitmaintained.com/project/colemars/devcontra-component "Average time to resolve an issue")
## What is it?
A data viz tool that aggregates all of your dev contribution activity into one component that can be easily integrated into your personal website.
Data is currently fetched from Twitter, Github, and StackOverflow, with support for Spectrum coming soon.
Each band in the timeline represents a week of dev activity, with 17 total bands, and the current, or most recent, week/band being the outermost. The type of activity is color coded according to the respective platform's brand.
## "Dev Activity"?
Your Github activity is determined by the commits, issues, and pull requests authored by you.
Your StackOverflow activity is determined by your posts, answers, and comments - as well as any badges you recieve.
Your Twitter activity is determined by parsing your tweets for relevant hashtags that match any existing StackOverflow tag. Support for adding tags to match against is coming soon.
## Installation
DevContra is available as an [npm package](https://www.npmjs.com/package/devcontra).
**[Stable channel v0](https://prod-devcontra.now.sh)**
```sh
// with npm
npm i devcontra
// with yarn
yarn add devcontra
```
Please note that `@next` will only point to pre-releases; to get the latest stable release use `@latest` instead.
## Usage
Here is a quick example to get you started, **it's all you need**:
```jsx
import React from 'react';
import DevContra from 'devcontra';
function App() {
return (
// test key
);
}
ReactDOM.render(, document.querySelector('#app'));
```
See it here in this live demo:
[](https://codesandbox.io/s/beautiful-shamir-m2h0z)
## Configuration
You can begin configuring your profile [here](devcontra.colemars.dev). After you create your account you will be able to set your twitter, stackoverflow, and github profiles, and receive your unique `profileKey`.
## Customization
Several optional `props` are available to customize your component.
`determinedMax` sets your domain, or the value you want your results to be relative to. If not set, it defaults to the nearest rounded up tenths place from your most active week. If your most active week has 72 contributions, your timeline will be set relative to a value of 80.
`diameter` is responsible for the size of your component. The default value is 350.
`padding` can be used to increase padding around the svg. Default padding is 0.
```jsx
import React from 'react';
import DevContra from 'devcontra';
function App() {
return (
// test key
);
}
ReactDOM.render(, document.querySelector('#app'));
```
## Questions
For *how-to* questions and other non-issues,
please free to use Github issues or contact me directly.
## Examples
[DevContra Demo](https://prod-devcontra.now.sh/demo)
## Contributing
Read the [contributing guide](/CONTRIBUTING.MD) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to DevContra.
## Changelog
Recently Updated?
Please read the [changelog](https://github.com/colemars/devcontra-component/releases).
## Roadmap
The future plans and high priority features and enhancements can be found [here](/ROADMAP.md).
## Utilizes
[
](https://github.com/)
GitHub's beta API allows for easy data fatching for repo activity history.
[
](https://circleci.com/)
Twitters's API allows for easy data fatching for tweet history.
[
](https://www.netlify.com/)
StackOverflow's API allows for easy data fatching for post history.
[
](https://crowdin.com/)
dynamoDb, Cognito, Cloudformation, API Gateway, IAM, and CloudWatch make continuous devopment and management of this tool as simple as possible.
[
](https://www.browserstack.com/)
BrowserStack allows us to test in real browsers.
[
](https://seed.run)
Seed.run allows for simple and quick API CI/CD pipeline management.
[
](https://serverless.com/)
Serverless Framework allows for building and operating a serverless application.
[
](https://zeit.co/)
ZEIT Now offers a great solution for site hosting.
[
](https://nextjs.org/)
NEXT.js is a React Framework that offers a great server side rendering solution.
## Other Repos
[DevContra Component](https://github.com/colemars/devcontra-component)
[DevContra Client](https://github.com/colemars/devcontra-client)
## License
This project is licensed under the terms of the
[MIT license](/LICENSE).