This is a repo for example usage of encites.
This 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), and overwrites report.md with the most recent markdown output.
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.
To generate a report:
- Clone the repo
- Remove the
output/directory (rm -rf ./output) - Update the
peoplearray in util/people.js with your GitHub username - Configure GitHub authentication
- Install the project's dependencies
npm install - Run the example report generator
node report.js # or `npm run report`
This will generate data and Markdown in /output/.
ecnites 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.
There'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.
See encites for more information on encites and the API it provides.