The stuff you actually need to know to build with this codebase.
development.md - How to get everything running locally without losing your mind
ci-cd.md - GitHub Actions setup and deployment (when you're ready to ship)
security-checklist.md - Things to check before you deploy (so you don't get hacked)
security-index.md - Security implementation details (the boring but important stuff)
../client-panda/README.md - React app details
../landing-panda/README.md - Astro landing page stuff
../server-panda/README.md - Express server setup
- Start with the main README.md to understand what this thing is
- Read development.md to get your dev environment working
- When you're ready to deploy, check security-checklist.md
- Can't get dev server running? → development.md
- Deploy failing? → ci-cd.md
- Security concerns? → security-index.md
- React app issues? → ../client-panda/README.md
Documentation should help you ship products, not win documentation contests. Everything here is:
- Practical - Actual steps you can follow
- Current - Updated when things change
- Honest - Admits when things are hard or broken
- Concise - Respects your time
If you find outdated info or something doesn't work, fix it. Future you (and everyone else) will thank you.
Built by people who actually use this stuff to ship products.