Welcome to the Scrunchy hackathon submission documentation!
This folder contains all the essential documentation created specifically for the Solana Consumer Track Hackathon submission.
HACKATHON_README.md ⭐ START HERE!
- Complete hackathon submission overview
- All 4 repository links with full details
- Technical architecture and stack
- API endpoints documentation
- Why Scrunchy wins (alignment with criteria)
- Success metrics and roadmap
- Quick start guide
- Contact information
- All repository links:
- scrunchy-contract - Smart Contracts
- scrunchy-backend - Backend API
- scrunchy-frontend - Frontend UI
- scrunchy-cli - CLI Tool
- Tech stack for each repository
- Setup instructions and quick start commands
- Key files and documentation links
- Repository statistics and health status
- Complete codebase structure for all 4 repositories
- File-by-file breakdown of each component
- Component interactions and data flow
- Database schema (Prisma models)
- Configuration examples
- Request flow diagrams
- Complete navigation index for all documentation
- Documentation organized by role (Judges, Developers, Contributors)
- Learning paths (4 different paths)
- Search guide to find what you need
- Quick links to all resources
- Support and contact information
👉 Start with: HACKATHON_README.md
This single document contains everything you need to evaluate the project:
- ✅ Project overview and vision
- ✅ All repository links
- ✅ Technical architecture
- ✅ Why Solana makes it possible
- ✅ Alignment with hackathon criteria
- ✅ Demo flow and deliverables
👉 Start with: INDEX.md
Then navigate to:
- REPOSITORY_LINKS.md - Clone repositories
- PROJECT_STRUCTURE.md - Understand codebase
- ../docs/ - Architecture documentation
👉 Start with: REPOSITORY_LINKS.md
Find contribution guidelines for each repository and get started!
| Repository | Link | Description |
|---|---|---|
| Smart Contracts | scrunchy-contract | Solana Anchor programs (Rust) |
| Backend API | scrunchy-backend | NestJS backend with event indexing |
| Frontend | scrunchy-frontend | Next.js marketplace UI |
| CLI Tool | scrunchy-cli | Universal CLI for game integration |
For more detailed technical documentation, see the main docs/ folder:
- 00_SCRUNCHY_PROJECT_OVERVIEW.md - Project overview
- 01_SCRUNCHY_SMART_CONTRACT_ARCHITECTURE.md - Smart contracts
- 02_SCRUNCHY_BACKEND_ARCHITECTURE.md - Backend
- 03_SCRUNCHY_FRONTEND_ARCHITECTURE.md - Frontend
- 04_SCRUNCHY_SDK_IMPLEMENTATION.md - SDK
- 05_SCRUNCHY_INTEGRATION_EXAMPLES.md - Examples
- INSTALLATION.md - Installation guide
- QUICK_START.md - Quick start guide
- ⚡ Sub-second transactions on Solana
- 💰 Sub-cent costs make micro-rentals viable
- 🎮 Cross-game interoperability - one asset, multiple games
- 🛠️ Universal CLI - works with any game engine
- 🎨 Beautiful UI - modern, polished design
- 🔒 Production-ready - comprehensive testing and documentation
- Total Lines of Code: ~32,000
- Total Files: ~430
- Repositories: 4
- Documentation Pages: 200+
- Status: ✅ 100% Complete
- GitHub: @hallelx2
- Email: [Your email]
- Twitter: [Your Twitter]
- Discord: [Your Discord]
- Main Documentation: ../docs/
- API Docs: http://localhost:3000/api/docs (Swagger UI - when backend running)
- Demo Video: [Link to be added]
- Live Demo: [Link to be added]
# Clone all repositories
git clone https://github.com/hallelx2/scrunchy-contract.git
git clone https://github.com/hallelx2/scrunchy-backend.git
git clone https://github.com/hallelx2/scrunchy-frontend.git
git clone https://github.com/hallelx2/scrunchy-cli.git
# Follow setup guides in HACKATHON_README.mdBuilt with ❤️ for the Solana Consumer Track Hackathon
Making blockchain gaming accessible, affordable, and fun for everyone.
Last Updated: December 15, 2025
Maintained by: hallelx2