https://github.com/redbadger/karma-tracker
Open Source contributions tracker for organisations
https://github.com/redbadger/karma-tracker
clojure github-api open-source
Last synced: 7 months ago
JSON representation
Open Source contributions tracker for organisations
- Host: GitHub
- URL: https://github.com/redbadger/karma-tracker
- Owner: redbadger
- License: gpl-3.0
- Created: 2017-01-25T11:27:52.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-04-18T18:00:26.000Z (over 8 years ago)
- Last Synced: 2025-04-17T00:18:36.744Z (7 months ago)
- Topics: clojure, github-api, open-source
- Language: Clojure
- Homepage:
- Size: 237 KB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Karma Tracker
Open source contributions' tracker for organisations
[](https://circleci.com/gh/redbadger/karma-tracker)
**NOTE: Karma Tracker is still work in progress and many more features and enhancement are planned to be released soon. Stay tuned!**
Karma Tracker generates contributions' reports to public projects by the developers of an organisation.
It uses the [GitHub events API v3](https://developer.github.com/v3/activity/events/) in order to track the
developers' activity and extract meaningful information.
The reports include information like: the top 20 projects, the top 10 languages, the types of contributions
and the developers involved. Each of them refers to a specific month of the year.
GitHub stores the last 300 events (or three months) for each developer so Karma Tracker stores them in a MongoDB database and read them later to create reports.
## Usage
To populate the database run a MongoDB instance (as explained later) and run the command
```shell
$ lein run update
```
when finished start the API server
```shell
$ lein run api
```
the server is going to listen to the port 8000.
Now you can start the UI
```shell
$ cd ui
$ ui> yarn
$ ui> yarn start
```
Open the browser at http://localhost:3333 and have fun.
## Running MongoDB
The app and tests need to connect to a MongoDB instance.
If you do not have one running locally, you can use the [official Docker image](https://hub.docker.com/_/mongo/):
```shell
$ docker-compose up -d
```
By default, the connection is to `mongodb://127.0.0.1:27017/karma-tracker`.
This may be overridden with the environment variable `MONGODB_URI`, which is of the form `mongodb://username:password@host:port/database`.