js-certificate-maker
Version:
A package to generate PDF certificates with custom names and styling
77 lines (55 loc) • 2.34 kB
Markdown
# Certificate Generator    
A Node.js package to generate personalized certificates in PDF format.
## Installation
```bash
npm i js-certificate-maker
```
## Features
- Dynamically generates personalized certificates for events, workshops, or courses
- Supports batch processing for multiple recipients
- Allows customization of font color and positioning
- Uses PDF-Lib library for robust PDF generation capabilities
## Usage
To generate certificates, use the following command:
```javascript
// Example usage:
const fontUrl = path.resolve(__dirname, "./assets/DancingScript-Variable.ttf");
const pdfTemplateUrl = path.resolve(__dirname, "./assets/certificate1.pdf");
const outputDir = path.resolve(__dirname, "output");
const names = ["John Doe", "Jane Smith", "Max Mustermann"];
const customColor = rgb(0.5, 0, 0.5);
generateCertificates(
fontUrl,
pdfTemplateUrl,
names,
outputDir,
customColor,
100,
-50
)
.then(() => console.log("All PDFs generated successfully"))
.catch((error) => console.error("Error generating PDFs:", error));
```
## Configuration
### generateCertificates(fontUrl, pdfTemplateUrl, names, outputDir, fontColor, xm, ym)
- `fontUrl` (string): Path to the font file (.ttf)
- `pdfTemplateUrl` (string): Path to the PDF template (.pdf)
- `names` (array of string): Array of names to generate certificates for
- `outputDir` (string): Directory to save generated PDFs
- `fontColor` (rgb): Color of the text (default: black)
- `xm` (number): X-axis offset (default: 0)
- `ym` (number): Y-axis offset (default: 0)
## Contributing
Contributions are welcome! Please feel free to submit pull requests or issues.
1. Fork and Clone the repository:
```
git clone https://github.com/yourusername/js-certificate-maker.git
```
2. Navigate to the project directory:
```
cd js-certificate-maker
```
3. Install dependencies:
```
npm install
```