Skip to content

HonorInk is an educational web application built with React 18 and Vite that enables users to create custom course completion certificates in PDF format. The application features an intuitive interface for customizing certificate details including name, course information, completion date, and skills covered,

Notifications You must be signed in to change notification settings

omkarspace/HonorInk

Repository files navigation

# Certificate Generator

A web application for generating custom course completion certificates in PDF format.

> **Note**: This project is for educational purposes only.

## Features

- Generate custom course completion certificates
- Download certificates as high-quality PDFs
- Customizable certificate fields:
  - First Name
  - Last Name 
  - Course Name
  - Completion Date
  - Course Length
  - Course Completion Time
  - Skills Covered

## Tech Stack

- React
- Vite
- PDF Generation Libraries
- TailwindCSS

## Prerequisites

- Node.js (Latest LTS version recommended)
- npm or yarn

## Installation

1. Clone the repository
```bash
git clone https://github.com/yourusername/certificate-generator.git
  1. Install dependencies
cd certificate-generator
npm install
  1. Start development server
npm run dev

Project Structure

src/
  ├── components/
  │   ├── Certificate.jsx
  │   └── CertificateForm.jsx
  ├── assets/
  │   └── images/
  ├── utils/
  │   └── pdfGenerator.js
  ├── styles/
  └── App.jsx

Usage

  1. Fill in the certificate details in the form
  2. Preview the generated certificate
  3. Download as PDF

Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Development

# Run development server
npm run dev

# Build for production
npm run build

# Run tests
npm run test

Security

This application runs entirely on the client side. No data is stored or transmitted to any servers.

Performance

  • Optimized PDF generation
  • Minimal bundle size
  • Efficient rendering

Browser Support

  • Chrome (latest)
  • Firefox (latest)
  • Safari (latest)
  • Edge (latest)

Troubleshooting

Common issues and solutions:

  1. PDF generation fails

    • Ensure all form fields are filled correctly
    • Check browser console for errors
  2. Certificate preview not showing

    • Clear browser cache
    • Refresh the page

License

This project is licensed under the MIT License.

Disclaimer

This project is intended for educational purposes only. Users are responsible for ensuring their use of this tool complies with relevant policies and regulations.

About

HonorInk is an educational web application built with React 18 and Vite that enables users to create custom course completion certificates in PDF format. The application features an intuitive interface for customizing certificate details including name, course information, completion date, and skills covered,

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published