Skip to content

hck-chain/hack-chain-app

Repository files navigation

🚀 Welcome to Hack Chain

Hack Chain is a web platform for issuing, validating, and tracing NFT-based certifications for ethical hacking and cybersecurity education. It uses blockchain to ensure transparent, immutable, and verifiable credentials.

📁 Branch Structure

  • main – Production-ready, stable code.
  • develop – Active development branch. Create your branches off this one.

📁 Project Structure

  • /frontend – Find it's README.md here.
  • /backend – Allows interaction between frontend and deployed smart contract by using ether.js library. Find it's README.md here.
  • /contracts - Contains the base smart contract, it's testing, and soon, a script for deploying the smart contact to some network. Find it's README.md here.

🛠️ Getting Started

To contribute locally, follow these steps:

✅ Prerequisites

  • Node.js & npm installed — Use NVM
  • Git installed

🚨 Clone & Setup

# 1. Clone the repository
git clone <YOUR_GIT_URL>

# 2. Move into the project folder
cd hack-chain

# 3. Install dependencies
npm install

# 4. Run the dev server (inside frontend/)
cd frontend
npm run dev

Note: Backend and smart contracts have their own package.json, install and run them separately.

🌱 How to Contribute

We're a small but passionate team, and we love collaborating!

  • 📄 Please read the CONTRIBUTING guide to get started.
  • Always create a branch from develop before starting any feature or fix.
  • Pull Requests should also be opened into develop.

💬 Community & Support

We welcome beginners, questions, feedback, and contributors of all skill levels!

About

Hack Chain is a web plaform for issuing, validating and tracing NFT-based certifications

Topics

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5