{"id":19068864,"url":"https://github.com/cutenode/encites-examples","last_synced_at":"2025-04-28T14:08:43.213Z","repository":{"id":40606523,"uuid":"360282406","full_name":"cutenode/encites-examples","owner":"cutenode","description":"Example usage of Encites","archived":false,"fork":false,"pushed_at":"2025-04-28T01:53:38.000Z","size":14077,"stargazers_count":5,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-28T14:08:30.373Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/cutenode.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2021-04-21T19:23:15.000Z","updated_at":"2025-01-07T19:39:37.000Z","dependencies_parsed_at":"2023-10-02T02:24:36.914Z","dependency_job_id":"ca722a22-cdc8-474f-a692-7b48a92f760d","html_url":"https://github.com/cutenode/encites-examples","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cutenode%2Fencites-examples","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cutenode%2Fencites-examples/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cutenode%2Fencites-examples/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cutenode%2Fencites-examples/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cutenode","download_url":"https://codeload.github.com/cutenode/encites-examples/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251326839,"owners_count":21571636,"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":"2024-11-09T01:12:25.593Z","updated_at":"2025-04-28T14:08:43.188Z","avatar_url":"https://github.com/cutenode.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# encites examples\n\nThis is a repo for example usage of [encites](https://github.com/cutenode/encites).\n\n## Examples\n\n### report.js\n\nThis is a basic report that you can run, showing off the most complicated potential usage of the encites API. It saves raw data, filtered data, timestamped Markdown files (via [luxon](https://npm.im/luxon)), and overwrites `report.md` with the most recent markdown output.\n\n\u003e **Note:** As of encites@3.0.0, there is a bug in encites when writing new directories. If you encounter this when running this on your own, just run it a couple times and the directories will resolve themselves. This will be  resolved in a future release of encites.\n\nTo generate a report:\n\n1. Clone the repo\n1. Remove the `output/` directory (`rm -rf ./output`)\n1. Update the `people` array in [util/people.js](util/people.js) with your GitHub username\n1. Configure [GitHub authentication](https://github.com/cutenode/encites#environment-variables)\n1. Install the project's dependencies\n    ```console\n    npm install\n    ```\n1. Run the example report generator\n    ```console\n    node report.js # or `npm run report`\n    ```\n\nThis will generate data and Markdown in `/output/`.\n\n### Running with GitHub Actions\n\necnites is designed to be run on a cron, so you consistently get data and can backfill any new GitHub events that encites adds in future versions from raw data that it outputs.\n\nThere's an exmaple GitHub action in this repository. You'll likely be able to copy/paste most of it, and modify it as necessary to suit your needs. You will be able to see example runs in the Actions tab of this repository.\n\n## More Information\n\nSee [encites](https://github.com/cutenode/encites) for more information on encites and the API it provides.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcutenode%2Fencites-examples","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcutenode%2Fencites-examples","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcutenode%2Fencites-examples/lists"}