Questlog

A comprehensive Web3 application for creating and managing quest-based gaming achievements with soulbound NFT badges.

This monorepo consists of three main components:

• questlog-frontend – React/TypeScript web application
• questlog-contracts – Solidity smart contracts (Foundry)
• questlog-backend – TypeScript backend services and APIs

npm run install:all   # Install all dependencies

cp questlog-frontend/.env.example questlog-frontend/.env
cp questlog-backend/.env.example questlog-backend/.env
cp questlog-contracts/.env.example questlog-contracts/.env

npm run validate:all   # Check envs, dependencies, and build

npm run dev:frontend   # Frontend dev server
npm run dev:backend    # Backend dev server
npm run deploy:contracts  # Deploy contracts

• npm run install:all – Install dependencies across modules
• npm run build:all – Build for production
• npm run test:all – Run tests
• npm run lint:all – Lint codebase
• npm run clean – Clear builds & node_modules
• npm run validate:all – Full validation (env, deps, build, tests)
• npm run setup:dev – Complete development setup
• npm run dev:frontend / npm run dev:backend – Start dev servers
• npm run deploy:contracts – Deploy smart contracts

questlog/
├── questlog-frontend/    # React app (UI, services, types)
├── questlog-backend/     # Backend (Supabase, Discord, IPFS)
├── questlog-contracts/   # Smart contracts (Solidity)
├── scripts/              # Validation utilities
└── package.json          # Monorepo config

• Discord OAuth for authentication
• Supabase for synced user data
• IPFS for decentralized metadata
• Blockchain for permanent proof of achievement
• Seamless UX blending Web2 familiarity with Web3 ownership

graph LR
    A[User Action] --> B[Frontend UI]
    B --> C[Backend Services]  
    C --> D[Database Storage]
    B --> E[Smart Contracts]
    E --> F[Blockchain Storage]
    F --> G[NFT Badge Minted]

1. User Interaction: Users interact with the React frontend.
2. Data Processing: Quest data processed and stored in Supabase.
3. Blockchain Integration: Badge minting triggered via smart contracts.
4. Permanent Storage: Achievements stored as soulbound NFTs on Lisk.

1. Validate Environment

npm run validate:env

2. Build & Test

npm run build:all
npm run test:all

3. Deploy (Order Matters)
   1. Contracts → cd questlog-contracts && npm run deploy
   2. Backend → Deploy via Railway, Render, or Vercel
   3. Frontend → cd questlog-frontend && vercel --prod

(See detailed deployment guides in module READMEs.)

• Smart Contracts: Soulbound tokens, strict owner minting, 95%+ test coverage
• Backend: Supabase RLS, env validation, API rate limits, secure OAuth
• Frontend: Type-safe API calls, wallet security, XSS prevention

1. Fork & Clone

git clone https://github.com/kashiwagiren/Questlog.git && cd Questlog

2. Setup Dev Environment – npm run setup:dev
3. Create Feature Branch – git checkout -b feature/your-feature
4. Develop & Run Dev Servers – npm run dev:frontend / npm run dev:backend
5. Validate & Lint – npm run validate:all && npm run lint:all
6. Submit Pull Request

✅ Strict TypeScript mode
✅ 90%+ test coverage
✅ ESLint + Prettier formatting
✅ Updated documentation with every architectural change

• Build Issues:

npm run clean && npm run install:all && npm run validate:all

• Dependency Conflicts:

npm run validate:deps

• Soulbound NFT badges
• Quest creation & management
• Discord OAuth integration

• Multi-chain deployment
• Advanced quests & verification
• Mobile app (React Native)

• Quest provider SDK
• Template marketplace

MIT License

• Questlog Frontend
• Questlog Contracts
• Questlog Backend

Built with ❤️ for the Web3 community