Home - PAiMo-io/PAiMo GitHub Wiki
π§ Welcome to the PAiMO Wiki
PAiMO (ζη) is a collaborative platform designed to simplify event planning and club management for communities and social groups.
This Wiki provides documentation, development guidelines, and technical references for contributors and developers working on the PAiMO project.
π Quick Start
If you're new to PAiMO, start here:
- π Tech Stack Overview
- ποΈ Project Structure
- π¦ Installing & Running Locally (Coming Soon)
- π Authentication & Authorization (Coming Soon)
𧩠Key Features
- User Profiles: Customizable profiles with avatars, WeChat ID, and nickname support
- Club Management: Create and manage clubs, roles, and memberships
- Event Scheduler: Plan and coordinate events with RSVPs and deadlines
- Notifications: Email and push notifications for critical actions
- Internationalization (i18n): Supports multiple languages (EN, ZH, VI, ES)
π Tech Highlights
- Frontend: Next.js 14, React 18, Tailwind CSS
- Backend: API Routes, NextAuth.js for auth
- Database: MongoDB with Mongoose ORM
- File Storage: Cloudflare R2 for avatars and media
- Deployment: Vercel & GitHub Actions (CI/CD)
Read the full β Tech Stack Overview
π₯ Contributor Guide
- π‘ See Good First Issues
- π§ͺ Test locally before submitting PRs
- π Follow our GitHub PR conventions and branch naming
π Upcoming Topics
(Weβre actively documenting the following β contributors welcome!)
- Project setup & environment variables
- Push notification implementation
- Database models
- UI component conventions
- Admin dashboard logic
π Contributing
We welcome contributors of all levels!