Skip to content

A Self-Hosted Certificate Generation and Management Solution for Event Organisers

License

arnav-kr/CertifiCat

Repository files navigation

CertifiCat 😸

A Self-Hosted Certificate Generation and Management Solution for Event Organisers

But How is it any different from other certificate generators?

  • CertifiCat is a self-hosted solution, which means you can host it on your own server under your own domain.
  • Unlike others, CertifiCat lets you bring your own templates to generate certificates for multiple events.
  • Not just a generator! CertifiCat comes with an Admin Panel and a user facing Download Page to both manage and distribute certificates.
  • CertifiCat is open-source and free to use.
  • And most importantly, cats...🧶🐈

Screenshots

Claim Certificate Create Event Admin Dashboard
Claim Certificate Create Event Admin Dashboard

Getting Started

clone the repository:

git clone https://github.com/arnav-kr/CertifiCat.git
cd CertifiCat

Install the dependencies:

yarn install

Build the project:

yarn build

Start the server:

yarn start

Server will start at localhost:3000

Usage

Pre-requisites

CertifiCat uses firebase for authentication, database. You need to create a firebase project with blaze plan and get the firebase config. It also uses MongoDB to store the certificates template base PDFs. You need to have a MongoDB instance running.

You can get the firebase config from the firebase console.

Project Setup

Create a .env.local file in the root of the project and add the required environment variables as listed in example.env

Authentication

enable email/password authentication in firebase console and create a user. This user will be the admin of the application.

Note

Disable the sign-up method in firebase console to prevent others from signing up.

Firestore and Storage

enable firestore and storage in firebase console.

Now your application is ready to use.

Admin Panel

Admin Panel is where you can manage your certificates and events. You can add new events, upload templates, and generate certificates.

Admin Panel will be available at localhost:3000/admin/dashboard

Download Page

Download Page is where users can download their certificates. They can enter their certificate code or user ids and download their certificate.

The homepage itself is the download page and will be available at localhost:3000

Development

clone the repository:

git clone https://github.com/arnav-kr/CertifiCat.git
cd CertifiCat

Install the dependencies:

yarn install

start the development server:

yarn dev

Dev server will start at localhost:3000

License

This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.

Contributors

About

A Self-Hosted Certificate Generation and Management Solution for Event Organisers

Topics

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •  

Languages