https://github.com/testdouble/cobbler
A tool to generate résumés for Test Double agents.
https://github.com/testdouble/cobbler
Last synced: about 2 months ago
JSON representation
A tool to generate résumés for Test Double agents.
- Host: GitHub
- URL: https://github.com/testdouble/cobbler
- Owner: testdouble
- License: mit
- Created: 2016-12-14T23:48:54.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-02-23T20:43:50.000Z (about 2 years ago)
- Last Synced: 2024-04-14T12:32:25.236Z (almost 2 years ago)
- Language: JavaScript
- Size: 50.8 KB
- Stars: 3
- Watchers: 49
- Forks: 6
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cobbler
Generates Test-Double-branded résumés from [JSON-Resume-compatible][json-resume] JSON documents.
## Options
| Option | Description |
|---|---|
| `-i, --input FILE` | Read from this JSON document, specified as a relative path. |
| `-o, --output FILE` | Write to this PDF file, specified as a relative path. |
## Process
1. Reads the input file.
2. Parses the input file as JSON.
3. Validates the parsed data matches the [JSON Resume schema][json-resume-schema].
4. Renders the internal template to HTML with the validated data.
5. Writes a print-ready PDF to the output file.
## Key Dependencies
- [JSON Resume][json-resume-npm], used for data validation.
- [Pug.js][pug], used for template rendering.
- [SASS][sass], used for styling.
- [Nightmare][nightmare], used for PDF generation.
- [Hummus][hummus], used for PDF annoatation.
## What's with the name?
We love ourselves some spycraft (and/or spy myth) at Test Double, and a "cobbler" is an expert in creating the necessary documentation for an Agent's work.
[json-resume]: https://jsonresume.org/
[json-resume-schema]: https://jsonresume.org/schema/
[json-resume-npm]: https://www.npmjs.com/package/resume-schema
[pug]: https://pugjs.org/api/getting-started.html
[sass]: https://www.npmjs.com/package/node-sass
[nightmare]: http://www.nightmarejs.org/
[hummus]: https://www.npmjs.com/package/hummus