search

Ahmedsaed / gdsc-cert

Certificate management web app. Create, Verify and Share Certificates.
https://gdsc-certificates.web.app/
MIT License
5 stars 1 forks source link
js nextjs

readme

GDSC Certificate Generator

This project is a certificate generator website for Google Developer Student Clubs (GDSC). It's built using Next.js and hosted on Firebase. The project also utilizes Firebase Hosting, Firebase Authentication and Firebase Database services, along with a Cloudflare worker.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Installation

  1. Clone the repo 
    git clone https://github.com/Ahmedsaed/gdsc-cert
  2. Navigate to the project directory 
    cd gdsc-cert
  3. Install the dependencies: 
    npm install

Project Setup

  1. Create a new Firebase project.
  2. Enable the following services:
    • Firebase Hosting
    • Firebase Authentication
    • Firebase Firestore Database
  3. Create a new web app to get the Firebase configuration.
  4. Update the configuration in firebase.js, .firebaserc and _app.js with your Firebase project configuration.
  5. Create GitHub secrets for build-deploy.yaml
    • FIREBASE_SERVICE_ACCOUNT_GDSC_CERT: Firebase service account JSON
    • ACCESS_TOKEN: GitHub access token

Usage

Development

To start the development server, run the following command:

npm run dev

Production

To build the project, run the following command:

npm run build

To start the production server, run the following command:

npm run start

For more information on how the project works, take a look at issue #3.

License

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

Contact