From 264158cf704f041d7f8231a0e785815c2879ee8a Mon Sep 17 00:00:00 2001 From: Marlon Vincent G Laurenciana <132250713+Murvile@users.noreply.github.com> Date: Mon, 9 Jun 2025 09:02:37 +0800 Subject: [PATCH] Update README.md --- README.md | 128 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 124 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 302483b..edc9279 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,102 @@ # `skillmint` -Welcome to your new `skillmint` project and to the Internet Computer development community. By default, creating a new project adds this README and some template files to your project directory. You can edit these template files to customize your project and to include your own code to speed up the development cycle. +🔗 **Live Demo:** [https://ns4pw-yyaaa-aaaam-aelaa-cai.icp0.io](https://ns4pw-yyaaa-aaaam-aelaa-cai.icp0.io) -To get started, you might want to explore the project directory structure and the default configuration file. Working with this project in your development environment will not affect any production deployment or identity tokens. +**Empowering ICT Students through Decentralized Proof of Skills** -To learn more before you start working with `skillmint`, see the following documentation available online: +SkillMint is a Web3 platform that enables college-level ICT students—especially those in provincial areas of the Philippines—to build verifiable skill portfolios, discover tech events, and earn blockchain-backed credentials and token rewards. + +--- + +## 📄 Executive Summary + +SkillMint is a decentralized platform designed to empower college-level ICT students—particularly those in provincial areas of the Philippines—by helping them build verifiable, blockchain-based portfolios. Through participation in hackathons, bootcamps, and tech seminars, students can earn NFT credentials and token rewards, showcasing their growth and skills in a trusted, transparent way. SkillMint also provides tools for event organizers to manage participation and issue verifiable badges, with plans to integrate into school systems for broader adoption. Powered by the Internet Computer Protocol (ICP), SkillMint ensures security, scalability, and accessibility for the next generation of tech talent. + +--- + +## Getting Started with `skillmint` + +Welcome to your new `skillmint` project and to the Internet Computer development community. This project was built with DFINITY's SDK and customized for SkillMint during the Philippine Blockchain Week 2025 iTHINK Hackathon. + +By default, creating a new project adds this README and some template files to your project directory. You can edit these template files to customize your project and to include your own code to speed up the development cycle. + +--- + +## 🔧 Useful Links for ICP Developers - [Quick Start](https://internetcomputer.org/docs/current/developer-docs/setup/deploy-locally) - [SDK Developer Tools](https://internetcomputer.org/docs/current/developer-docs/setup/install) -If you want to start working on your project right away, you might want to try the following commands: +--- + +## 🛠 Tech Stack + +| Layer | Technology | +|-------------------|---------------------------------------| +| Frontend | React.js | +| Backend | Motoko (Internet Computer Protocol) | +| Blockchain | Internet Computer Protocol (ICP) | +| Auth | Internet Identity | +| Storage | ICP Native Canister Storage | +| Dev Tools | GitHub, Figma, Excalidraw, draw.io | + +--- + +## 🧩 Solution Features + +- 🎓 Blockchain-secured student portfolios +- 🛠 Project builder (GitHub links, NFT badges, certificates) +- 📅 Event discovery and application board +- 🏆 Token rewards for participation and competition wins +- 🧑‍🏫 Organizer dashboards for event verification +- 🔐 Seamless authentication via Internet Identity + +--- + +## 🪙 Token System (SkillMint Token - SMT) + +| Activity | Reward | +|---------------------------|-------------| +| Event Attendance | +10 SMT | +| Event Completion | +20 SMT | +| Competition Win (1st–3rd) | +50–100 SMT | +| Peer Feedback | +5 SMT | +| Referral/Invites | +10 SMT | + +*Tokens are off-chain in MVP and will transition to ICP ICRC-based on-chain format in v2.0.* + +--- + +## 🌐 Why Internet Computer (ICP)? + +- 🔐 Internet Identity login—no wallet needed for students +- ⚡ Motoko-powered smart contracts +- 📦 On-chain storage for credentials and event logs +- 🧩 End-to-end decentralized dApp delivery +- 🔄 Interoperability via ICRC tokens + +--- + +## 📈 Roadmap + +| Phase | Milestone | Timeline | +|-------|------------------------------------------------|----------| +| 1 | MVP (profile + events + basic verification) | June 2025 | +| 2 | Token reward system + school onboarding | Q3 2025 | +| 3 | University pilot + school integrations | Q4 2025 | +| 4 | Token goes on-chain (ICRC standard) | Q1 2026 | + +--- + +## 👨‍💻 Local Development Guide + +To begin development, explore the structure and configuration of your project. You can try the following commands: + +```bash +cd skillmint/ +dfx help +dfx canister --help + ```bash cd skillmint/ @@ -55,3 +142,36 @@ If you are hosting frontend code somewhere without using DFX, you may need to ma - use your own preferred method to replace `process.env.DFX_NETWORK` in the autogenerated declarations - Setting `canisters -> {asset_canister_id} -> declarations -> env_override to a string` in `dfx.json` will replace `process.env.DFX_NETWORK` with the string in the autogenerated declarations - Write your own `createActor` constructor + +### ⚙️ Frontend Environment Notes + +If you are hosting frontend code somewhere without using DFX, you may need to make one of the following adjustments to ensure your project does not fetch the root key in production: + +- Set `DFX_NETWORK=ic` if you are using Webpack +- Replace `process.env.DFX_NETWORK` manually in your declarations +- Or in `dfx.json`, set: + ```json + "declarations": { + "env_override": "ic" + } + +Team +## Marlon Vincent G. Laurenciana – Project Manager + +Rhyen Jan O. Natividad – Tech Lead + +Loyd Martin B. Vendiola – Backend Developer + +Simonee Ezekiel Mariquit – Frontend Developer + +Angela N. Tallon – Designer + +## 📣 Call to Action + +We’re looking for: +- 🎓 School partners for pilot integrations +- 🏢 Event organizers and tech sponsors +- 💡 Mentors, developers, and community supporters + +Reach out via LT05marc@gmail.com. +