{"id":25469773,"url":"https://github.com/paulorccamargo/github-data-reporter","last_synced_at":"2025-11-04T17:30:22.515Z","repository":{"id":277785348,"uuid":"933352317","full_name":"devpaulorcc/github-data-reporter","owner":"devpaulorcc","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-16T04:24:31.000Z","size":106,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-16T05:20:09.663Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devpaulorcc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2025-02-15T18:46:06.000Z","updated_at":"2025-02-16T04:24:35.000Z","dependencies_parsed_at":"2025-02-16T05:34:17.155Z","dependency_job_id":null,"html_url":"https://github.com/devpaulorcc/github-data-reporter","commit_stats":null,"previous_names":["devpaulorcc/github-data-reporter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devpaulorcc%2Fgithub-data-reporter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devpaulorcc%2Fgithub-data-reporter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devpaulorcc%2Fgithub-data-reporter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devpaulorcc%2Fgithub-data-reporter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devpaulorcc","download_url":"https://codeload.github.com/devpaulorcc/github-data-reporter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239436790,"owners_count":19638369,"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":[],"created_at":"2025-02-18T08:30:47.068Z","updated_at":"2025-11-04T17:30:22.453Z","avatar_url":"https://github.com/devpaulorcc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"http://nestjs.com/\" target=\"blank\"\u003e\u003cimg src=\"https://nestjs.com/img/logo-small.svg\" width=\"120\" alt=\"Nest Logo\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# 🚀 GitHub Data Reporter\n\n## 📌 Description\n\nThe **GitHub Data Reporter** is an application developed with the [NestJS](https://nestjs.com/) framework that collects and generates detailed reports on GitHub repositories. It allows users to gain valuable insights into the activity and performance of their GitHub-hosted projects.\n\n## 🎯 Features\n\n- 📊 **Data Collection**: Extracts relevant information from GitHub repositories, such as total commits per week, total repositories, overall activities, and more.\n- 📑 **Report Generation**: Creates comprehensive reports in user-friendly formats, making it easier to analyze and share the collected information.\n- ⏰ **Continuous Monitoring**: Every **Friday at 8:00 PM**, a new report will be sent to the registered email.\n\n## ✅ Prerequisites\n\nBefore starting, make sure you have the following installed on your machine:\n\n- 🟢 [Node.js](https://nodejs.org/) (version 14 or higher)\n- 📦 [npm](https://www.npmjs.com/) (Node.js package manager)\n\n## 🛠 Installation\n\n1. **Clone the repository**:\n\n   ```bash\n   git clone https://github.com/devpaulorcc/github-data-reporter.git\n   ```\n\n2. **Navigate to the project directory**:\n\n   ```bash\n   cd github-data-reporter\n   ```\n\n3. **Install dependencies**:\n\n   ```bash\n   npm install\n   ```\n\n## ⚙️ Configuration\n\nBefore running the application, you need to configure the environment variables:\n\n1. **Create a `.env` file** in the root directory of the project, based on the provided `.env-example` file.\n\n2. **Set the following variables** in the `.env` file:\n\n   ```env\n   MAIL_HOST=smtp.gmail.com\n   MAIL_PORT=587\n   MAIL_USER=email@email.com\n   MAIL_PASS=xxxx xxxx xxxx xxxx\n   MAIL_FROM=email-from\n   GITHUB_TOKEN=your_github_token\n   ```\n\n   - 🔑 `GITHUB_TOKEN`: Your personal GitHub access token. You can generate a new token in the [GitHub Developer Settings](https://github.com/settings/tokens).\n\n## 🚀 Usage\n\nTo start the application, use the following command:\n\n```bash\nnpm run start\n```\n\nThe application will run in development mode. For other execution modes:\n\n- 🛠 **Development mode with hot-reload**:\n\n  ```bash\n  npm run start:dev\n  ```\n\n- 🚀 **Production mode**:\n\n  ```bash\n  npm run start:prod\n  ```\n\n## 🤝 Contributing\n\nContributions are welcome! If you want to improve this project, follow these steps:\n\n1. **Fork this repository**.\n\n2. **Create a new branch** for your feature or fix:\n\n   ```bash\n   git checkout -b my-new-feature\n   ```\n\n3. **Commit your changes**:\n\n   ```bash\n   git commit -m 'feat: add new functionality'\n   ```\n\n4. **Push to the remote repository**:\n\n   ```bash\n   git push origin my-new-feature\n   ```\n\n5. **Open a Pull Request** detailing your changes.\n\n## 📜 License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulorccamargo%2Fgithub-data-reporter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaulorccamargo%2Fgithub-data-reporter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulorccamargo%2Fgithub-data-reporter/lists"}