{"id":22994204,"url":"https://github.com/offensive-vk/auto-contributions","last_synced_at":"2025-04-02T12:41:04.595Z","repository":{"id":265631830,"uuid":"893519901","full_name":"offensive-vk/auto-contributions","owner":"offensive-vk","description":"A Github Action that generates the Contributions, Coding Style, Most Used Languages of a Github User in SVG Format.","archived":false,"fork":false,"pushed_at":"2025-03-09T15:01:12.000Z","size":3965,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T19:13:17.181Z","etag":null,"topics":["automation","contribution","github-action","profile","svg"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/auto-3d-contributions","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/offensive-vk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-24T16:50:13.000Z","updated_at":"2025-03-09T15:01:10.000Z","dependencies_parsed_at":"2025-03-09T16:18:31.261Z","dependency_job_id":"18524889-ad72-4052-b847-b045d7bfb8e8","html_url":"https://github.com/offensive-vk/auto-contributions","commit_stats":null,"previous_names":["offensive-vk/auto-contributions"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-contributions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-contributions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-contributions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/offensive-vk%2Fauto-contributions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/offensive-vk","download_url":"https://codeload.github.com/offensive-vk/auto-contributions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246819552,"owners_count":20839088,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","contribution","github-action","profile","svg"],"created_at":"2024-12-15T05:17:20.912Z","updated_at":"2025-04-02T12:41:04.570Z","avatar_url":"https://github.com/offensive-vk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🌟 Auto Contributions - Profile 3D SVGs 🌐  \n\n[🇯🇵 日本語](./docs/README.ja-jp.md) | [🇪🇸 Español](./docs/README.es-es.md)  \n\n## 📖 Overview  \n\nThis GitHub Action 🛠️ creates an eye-catching **3D contribution calendar** 🗓️ for your GitHub profile 🎨.  \n\n## 🚀 How to Use (GitHub Actions) - Basic  \n\nThis action generates a **3D contribution calendar** for your profile and automatically commits the SVG to your repository 📤. You can also manually trigger it if needed 🔄.  \n\n### 🛠️ Step 1. Create a Special Repository  \n\nCreate a repository on GitHub named after your username 📝.  \n\nFor example:  \n- If your username is `mona`, create a repository named `mona/mona`.  \n\n📖 Reference: [Managing Your Github Profile Readme](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme).  \n\n---\n\n### 🛠️ Step 2. Create a Workflow File  \n\nCreate the following workflow file at `.github/workflows/contributions.yml`:  \n\n```yaml\nname: Auto Contributions\n\non:\n  schedule:\n    - cron: \"0 8 * * *\" # Adjust the time as per your preference.\n  workflow_dispatch:\n\njobs:\n  generate:\n    runs-on: ubuntu-latest\n    name: Generate 3D Profile SVGs\n    steps:\n      - uses: actions/checkout@v4\n      - uses: ./ \n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          USERNAME: ${{ github.repository_owner }}\n\n      - name: Commit \u0026 Push\n        run: |\n          git config user.name ${{ github.actor }}\n          git config user.email ${{ github.actor }}@users.noreply.github.com\n          git add .\n          git commit -m \"Updated 3D Profile SVGs.\"\n          git push\n```  \n\n💡 **Tip:** If you want to include private repositories, generate a **personal access token** 🔐 and set it to `GITHUB_TOKEN`.  \n\n---\n\n### 🛠️ Step 3. Manually Launch the Action  \n\nNavigate to:  \n`Actions` → `GitHub-Profile-3D-Contrib` → `Run workflow`.  \n\nThe following profile images will be generated:  \n\n📂 **Generated Files:**  \n- `profile-3d-contrib/profile-green-animate.svg`  \n- `profile-3d-contrib/profile-season-animate.svg`  \n- `profile-3d-contrib/profile-night-view.svg`  \n- `profile-3d-contrib/profile-gitblock.svg`  \n(*and more variations!*)  \n\nIf you specify a custom `SETTING_JSON`, a unique image will be generated:  \n- `profile-3d-contrib/profile-customize.svg`  \n\n---\n\n### 🛠️ Step 4. Add the Generated Image to Your README  \n\nAdd the generated SVG to your profile README 📜:  \n\n```md\n![](./profile-3d-contrib/profile-green-animate.svg)\n```  \n\n---\n\n## 🎨 Demo  \n\nHere are some examples of the stunning 3D contribution SVGs this action generates:  \n\n- **Green Animated Version:**  \n  ![Green Animate](https://raw.githubusercontent.com/offensive-vk/auto-contributions/master/docs/demo/profile-green-animate.svg)  \n\n- **Season (Northern Hemisphere):**  \n  ![Season Northern](https://raw.githubusercontent.com/offensive-vk/auto-contributions/master/docs/demo/profile-season-animate.svg)  \n\n- **Night View Version:**  \n  ![Night View](https://raw.githubusercontent.com/offensive-vk/auto-contributions/master/docs/demo/profile-night-view.svg)  \n\n---\n\n## 🖥️ How to Use (Local)  \n\nYou can also generate the 3D contribution calendar locally:  \n\n1. Set the `GITHUB_TOKEN` environment variable with your **personal access token**:  \n   ```bash\n   export GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXX\n   ```  \n\n2. Run the script using your GitHub username:  \n   ```bash\n   npm run build\n   node . YOUR_USERNAME\n   ```  \n\n---\n\n## 📜 License  \n\nThis project is licensed under the **MIT License**. 📝  \n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003ci\u003e\u0026copy; \u003ca href=\"https://github.com/offensive-vk/\"\u003eVedansh \u003c/a\u003e 2020 - Present\u003c/i\u003e\u003cbr\u003e\n  \u003ci\u003eLicensed under \u003ca href=\"https://github.com/offensive-vk/auto-contributions?tab=MIT-1-ov-file\"\u003eMIT\u003c/a\u003e\u003c/i\u003e\u003cbr\u003e\n  \u003ca href=\"https://github.com/TheHamsterBot\"\u003e\u003cimg src=\"https://i.ibb.co/4KtpYxb/octocat-clean-mini.png\" alt=\"hamster\"/\u003e\u003c/a\u003e\u003cbr\u003e\n  \u003csup\u003eThanks for visiting :)\u003c/sup\u003e\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffensive-vk%2Fauto-contributions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foffensive-vk%2Fauto-contributions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foffensive-vk%2Fauto-contributions/lists"}