https://github.com/arnav-kr/certificat
A Self-Hosted Certificate Generation and Management Solution for Event Organisers
https://github.com/arnav-kr/certificat
admin-dashboard arnav-kr certificat certificate-generation certificates event-management nextjs react
Last synced: 2 months ago
JSON representation
A Self-Hosted Certificate Generation and Management Solution for Event Organisers
- Host: GitHub
- URL: https://github.com/arnav-kr/certificat
- Owner: arnav-kr
- License: agpl-3.0
- Created: 2025-01-21T10:10:42.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-03-30T09:24:43.000Z (3 months ago)
- Last Synced: 2025-04-12T17:12:07.536Z (2 months ago)
- Topics: admin-dashboard, arnav-kr, certificat, certificate-generation, certificates, event-management, nextjs, react
- Language: TypeScript
- Homepage: https://enigma-certs.vercel.app
- Size: 1.64 MB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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 |
## Getting Started
clone the repository:
```bash
git clone https://github.com/arnav-kr/CertifiCat.git
cd CertifiCat
```
Install the dependencies:
```bash
yarn install
```
Build the project:
```bash
yarn build
```
Start the server:
```bash
yarn start
```
Server will start at [localhost:3000](http://localhost:3000)
## Usage
### Pre-requisites
CertifiCat uses [firebase](https://firebase.google.com/) 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](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](http://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](http://localhost:3000)
## Development
clone the repository:
```bash
git clone https://github.com/arnav-kr/CertifiCat.git
cd CertifiCat
```
Install the dependencies:
```bash
yarn install
```
start the development server:
```bash
yarn dev
```
Dev server will start at [localhost:3000](http://localhost:3000)
## License
This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE) file for details.
## Contributors
