Skip to content

DEV_ONBOARDING.md

Latest commit

 

History

History
91 lines (65 loc) · 3.06 KB

DEV_ONBOARDING.md

File metadata and controls

91 lines (65 loc) · 3.06 KB
Raw

DexHuntHub Personal Dev Onboarding & Engineering Guide

Note: Your local folder can be named DexHuntHub, DexHunt.github.io, or anything you like. The folder name does not affect your code or git history. You can push/pull to any GitHub repo (FifthGenHub, DexHuntHub, etc.) as needed. Just make sure you are in the correct folder when running git commands.

Welcome, DexHunt Dev! This is your personal engineering playbook—use it to stay organized, focused, and always know what to do next as you build, secure, and launch DexHunt.

1. Local Dev Environment

  • Ensure Node.js and npm are installed
  • Clone the repo and run npm install (if using dependencies)
  • Set up your preferred code editor (VS Code recommended)
  • Familiarize yourself with the project structure

2. Coding Standards & Best Practices

  • Use clear, consistent naming and modular code
  • Add comments for all complex logic
  • Keep functions small and focused
  • Avoid code duplication—reuse and refactor
  • Use .env for secrets (never commit private keys)

3. Git & Version Control

  • Commit early, commit often, and write clear messages
  • Use branches for new features or experiments
  • Push to remote regularly (even if private)
  • Tag releases and major milestones

4. Testing & QA

  • Write unit tests for all core logic (see js/index.test.js)
  • Manually test all UI flows (wallet, duel, shop, leaderboard)
  • Test on multiple browsers and devices
  • Check for regressions after every major change

5. Security & Compliance

  • Never expose private keys or sensitive data in code
  • Validate all user input (client and server)
  • Regularly review dependencies for vulnerabilities
  • Keep legal, privacy, and terms pages up to date

6. Blockchain & Wallet Integration

  • Use Solana web3.js for wallet and transaction logic
  • Test wallet connect/disconnect, transaction signing, and error handling
  • Simulate mainnet/testnet flows before going live

7. Deployment & CI/CD

  • Use a staging branch or environment for pre-prod testing
  • Automate builds and deploys if possible
  • Back up all critical data and configs

8. Personal Workflow & Focus

  • Review the DEXHUNT_SUCCESS_GUIDE.md weekly
  • Prioritize security, transparency, and user experience
  • Keep a TODO list for daily/weekly focus
  • Celebrate progress—this is a marathon, not a sprint!

9. When Ready to Onboard Others

  • Prepare a public CONTRIBUTING.md with code standards and PR process
  • Document all APIs, endpoints, and data models
  • Set up code review and merge guidelines

10. Stay Inspired

  • Remember why you started DexHunt
  • Keep learning—Web3, eSports, and gaming are always evolving
  • Reach out to the community for feedback and support

11. eSports Vision & Leadership

  • Ensure all new features and documentation reference $DEXHUNT's eSports vision and leadership in skill-based Web3 gaming where relevant.

Last updated: May 27, 2025