KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

auto-contribution

★ 41 Open GitHub ↗

:octocat: Auto generating contributions each week

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

## auto-contribution

[![Pay](https://img.shields.io/badge/%24-free-%23a10000.svg)](https://raw.githubusercontent.com/aleen42/auto-contribution/master/) [![GitHub issues](https://img.shields.io/github/issues/aleen42/auto-contribution.svg)](https://github.com/aleen42/auto-contribution/issues) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/aleen42/auto-contribution/master/LICENSE) [![Gitter](https://badges.gitter.im/aleen42/auto-contribution.svg)](https://gitter.im/aleen42/auto-contribution?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![npm version](https://badge.fury.io/js/auto-contribution.svg)](https://badge.fury.io/js/auto-contribution) [![Build Status](https://travis-ci.org/aleen42/auto-contribution.svg?branch=master)](https://travis-ci.org/aleen42/auto-contribution) [![npm](https://img.shields.io/npm/dt/auto-contribution.svg)](https://www.npmjs.com/package/auto-contribution)

a node.js module for automatically generating contributions on github without worrying about its movement in the next week. which is **only used on Linux OS.**

### Installation

#### NPM Installation

```bash
npm install auto-contribution
cd ./node_modules/auto-contribution
npm i
```

#### Clone Installation

```bash
git clone https://github.com/aleen42/auto-contribution.git
cd auto-contribution
npm i
```

### Usage

1. Create a repository to store generated commits history.

2. Install dependencies:

```bash
    npm i --no-save
    ```

3. Create a json file with [**IonicaBizau/github-contributions**](https://github.com/IonicaBizau/github-contributions)

Run server.

```bash
    npm run server
    ```

And visit the website `http://localhost:9000`.

Build up a colorful calendar for yourself, and then generate json data, which should be store into a json file.

4. Start to update with root mode

```bash
    npm run start <repo-url> <coordinates data json file path>
    
    # example: npm start git@github.com:aleen42/contribution.git example.json
    ```

- *repo-url under SSH: the repo url should be under SSH protocol like `git@github.com:aleen42/contribution.git` so that we can run the script in a **crontab** task.*
    - *coordinates data json file path: you should put your data generated by [**IonicaBizau/github-contributions**](https://github.com/IonicaBizau/github-contributions) into a json file and give the path of it, and here is an [example](./example.json) of json file of aboved result*

If you set up all the things and it should run like this, and waiting for the result cause it will behave so slow when your `commitsPerDay` is large.

5. Without any problems of updating remote repository, you can use `crontab` to set this script in the root mode to automatically update every week like this:

```bash
    # su
    # crontab -e
    
    # Edit this file to introduce tasks to be run by cron.
    #
    # Each task to run has to be defined through a single line
    # indicating with different fields when the task will be run
    # and what command to run for the task
    #
    # To define the time you can provide concrete values for
    # minute (m), hour (h), day of month (dom), month (mon),
    # and day of week (dow) or use '*' in these fields (for 'any').#
    # Notice that tasks will be started based on the cron's system
    # daemon's notion of time and timezones.
    #
    # Output of the crontab jobs (including errors) is sent through
    # email to the user the crontab file belongs to (unless redirected).
    #
    # For example, you can run a backup of all your user accounts
    # at 5 a.m every week with:
    # 0 5 * * 1 tar -zcf /var/backups/home.tgz /home/
    #
    # For more information see the manual pages of crontab(5) and cron(8)
    #
    # m h  dom mon dow   command
    0 0 * * 0 cd /opt/lampp/htdocs/auto-contribution && npm start git@github.com:aleen42/contribution.git example.json
    ```

### Tests

```bash
npm run test
```

*Notice that: the repository generated with test case will be in `./auto-contribution/node_modules/gh-contributions/lib/public/repos/`*

### Released

* 1.0.0 Initial release
	* 1.1.0 Catch some exceptions
	* 1.1.1 Update readme.md
	* 1.2.0 Add progress to improve interaction
	* 1.2.1 Update readme.md

### :fuelpump: How to contribute

Have an idea? Found a bug? See [how to contribute](https://aleen42.github.io/PersonalWiki/contribution.html).

### :scroll: License

auto-contribution

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README