Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/priyanshuverma-dev/sharecert

Sharecert is a platform designed for individuals who want to securely upload, showcase, and verify their certificates and achievements. Whether you're a student showcasing academic accolades, a professional displaying certifications, or an organization verifying credentials, Sharecert offers a decentralized and reliable solution.
https://github.com/priyanshuverma-dev/sharecert

decentralized flagsmith ipfs

Last synced: 16 days ago
JSON representation

Sharecert is a platform designed for individuals who want to securely upload, showcase, and verify their certificates and achievements. Whether you're a student showcasing academic accolades, a professional displaying certifications, or an organization verifying credentials, Sharecert offers a decentralized and reliable solution.

Awesome Lists containing this project

README

        

# Sharecert

Sharecert is a platform where users can securely upload, showcase, and verify their certificates and achievements on the InterPlanetary File System (IPFS).

## Table of Contents

- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Features

- **Decentralized Storage**: Certificates and achievements are stored securely on IPFS for decentralized and permanent access.
- **Verification**: Employing blockchain technology or other methods for verifying the authenticity of uploaded certificates.
- **User-Friendly Interface**: Intuitive design for easy uploading, viewing, and managing of certificates.

## Getting Started

### Prerequisites

Before you begin, ensure you have the following prerequisites:

- [Node.js](https://nodejs.org/) (version 18.X.X)
- [IPFS](https://ipfs.io/) (optional: if you want to run your own IPFS node)

### Installation

1. Clone the repository:

```bash
git clone https://github.com/your-username/Sharecert.git
```

2. Navigate to the project directory:

```bash
cd Sharecert
```

3. Install dependencies:

```bash
pnpm install
```

## Usage

1. Start the Sharecert application:

```bash
pnpm dev
```

2. Create a `.env` file in the root directory of the project with the following environment variables:

```env
DATABASE_URL="mongodb://localhost:27017/sharecert"

AUTH_GOOGLE_SECRET="google-secret-key"
AUTH_GOOGLE_ID="google-id"

AUTH_GITHUB_SECRET="github-secret-key"
AUTH_GITHUB_ID="github-id"

AUTH_URL="http://localhost:3000/api/auth"
AUTH_SECRET="secret-key"

NEXT_PUBLIC_URL="http://localhost:3000"
NEXT_PUBLIC_IPFS_KEY="ipfs-key"
```

3. Generate prisma client:

```bash
pnpm dlx prisma generate
```

4. Open your web browser and go to [http://localhost:3000](http://localhost:3000).

5. Follow the on-screen instructions to upload, showcase, and verify certificates.

## Contributing

We welcome contributions from the community! If you'd like to contribute to Sharecert, please follow our [Contribution Guidelines](CONTRIBUTING.md).

## License

This project is licensed under the [MIT License](LICENSE).