Back to Project List

Certificates Ninja

Certificates.ninja is a free and open-source web application for event organizers to easily create 'immutable and tamper resistant' certificates powered by Blockchain and NFTs.

Respository Video ▶️

Logo

Certificates Ninja

A FOSS tool for event organizers to send bulk certificates to participants in a matter of few clicks.



About The Project

[Product Name Screen Shot

Are you hosting an event and do you wish to present certificates to your participants? With Certificates Ninja, you can seamlessly send certificates and event badges in just a couple of clicks. Certificates Ninja helps you to automate the process of making individual certificates for each of the participants and deliver it to them over email. The certificates can also be optionally saved on IPFS meaning that they will be persistant forever and can be easily verified using our verification tool.

Built With

Frontend

  • NextJS
  • TailwindCSS
  • ChakraUI

Backend, middleware and utilities

  • NodeJS
  • Redux
  • ExpressJS
  • NPM

(back to top)

In order to run Certificates Ninja locally, run the client and the server using the instructions provided.

Running the client

Clone the repository

Download the code from this repository or clone the repository using the following command

git clone https://github.com/Certificates-Ninja/Frontend.git

Installing the dependencies

Install the required dependencies using the following command

npm install

(back to top)

Setting up .env

Rename the .env.example file into .env or alternatively create a file called .env with the following. This specifies that the server will run on port 3001.

NEXT_PUBLIC_BACKEND_DOMAIN=http://localhost:3001

(back to top)

Running the frontend

Run the front end using the following command

npm run dev

(back to top)

Running the server

Clone the repository

Download the code from this repository or clone the repository using the following command

git clone https://github.com/Certificates-Ninja/Backend.git

Installing the dependencies

Install the required dependencies using the following command

npm install

(back to top)

Setting up .env

Rename the .env.example file into .env or alternatively create a file called .env with the following. Kindly fill your own SMTP details or get free testing credentials from Mail trap.

SESSION_SECRET="THIS SHOULD BE SUPER SECRET"

SMTP_HOST=smtp.mailtrap.io

SMTP_PORT=

SMTP_USERNAME=

SMTP_PASSWORD=

(back to top)

Running the backend

Run the back end using the following command

npm start

(back to top)

Roadmap

  • [x] Importing participants
  • [x] Choosing in-built or custom templates
  • [x] Sending email to the participants
  • [x] Uploading on IPFS
  • [ ] Verifying the document by comparing the IPFS UID

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Reach out to us on email : kumaragurut7@gmail.com if you have any queries.

(back to top)

Attributions

(back to top)

Kumaraguru
Adithya Menon S
Bhuvanesh T G

Final Update :

Thanks for the amazing opportunity. Feel free to checkout our demo video. Star our repo if you liked it. All instructions to run locally, technology stack and attributions can be found in the README.

November 14, 2021

Update #6

We have successfully completed the core features that we had planned. However, we have the documentation works and video left.

November 14, 2021

Update #5

The backend is completed except the decentralized storage parts. We are currently working with Axios to connect the server with the client and we are expected to complete this by a couple of minutes. Up next is documentation, video and implementing decentralized storage and minting the certificate as an NFT.

November 14, 2021

Update #4

All the required routes and pages have been completed. There is a bit of work left in the frontend with the fonts and alignments.

November 14, 2021

Update #3

We have successfully completed 50% of the frontend. The backend is also being developed parallely.

-[x] Home page -[x] Ask for SMTP Credentials -[x] Import participant data -[] Select certificate template -[] Create your own certificate template -[] Emails sent successfully

November 14, 2021

Update #2 Started working on certificate generation - [X] Participants import - [] Select template - [] Generate certificates - [] Mailing certificates

November 13, 2021

Update #1

We made a new GitHub Organization for our project. We have 2 repositories : frontend and backend respectively. Feel free to checkout our code.

November 13, 2021

Project created by Kumaraguru

November 13, 2021