MeishiBridge is a full-stack digital business card platform designed for Japanese business culture with QR codes, PDF export, and bilingual support (日本語/English).
Why MeishiBridge?
- Built for Japanese meishi (名刺) culture
- Modern tech stack (Nuxt 4, FastAPI, Flutter)
- Split deployment: Vercel frontend + Vercel backend + Neon Postgres
- AI-ready (Python backend for OCR, translation)
- Multi-platform (Web + iOS + Android)
| Layer | Technology | Version | Purpose |
|---|---|---|---|
| Frontend | Nuxt 4 | 4.4+ | Web application |
| TypeScript | 5.x | Type safety | |
| Tailwind CSS | 3.x | Styling | |
| Backend | Python | 3.11+ | API server |
| FastAPI | 0.109+ | REST API framework | |
| PostgreSQL | 15+ | Database | |
| Mobile | Flutter | 3.24+ | iOS/Android apps |
| Dart | 3.5+ | Programming language | |
| DevOps | Docker | Latest | Containerization |
| Terraform | 1.x | Infrastructure as Code |
This project is organized into 4 independent modules, each with detailed documentation:
| Module | Description | Tech Stack | Documentation |
|---|---|---|---|
| web/ | Frontend web application | Nuxt 4 + TypeScript + Tailwind | Web README |
| api/ | Backend REST API | Python 3.11 + FastAPI + PostgreSQL | API README |
| mobile/ | iOS & Android apps | Flutter 3.24+ + Dart 3.5+ | Mobile README |
| infra/ | Infrastructure & DevOps | Docker + Terraform + CI/CD | Infra README |
meishi-link-nuxt-python/
├── web/ # Frontend → See web/README.md
├── api/ # Backend → See api/README.md
├── mobile/ # Mobile Apps → See mobile/README.md
├── infra/ # Infrastructure → See infra/README.md
└── README.md # This file (Overview)
Each module has its own detailed README with setup, development, testing, and deployment instructions.
# Clone repository
git clone https://github.com/dinkar1708/meishi-bridge-nuxt-python.git
cd meishi-bridge-nuxt-python
# Start all services with Docker
cd infra
docker-compose up -d
# Frontend: http://localhost:3000
# API: http://localhost:8000
# API Docs: http://localhost:8000/docsMore details: See Infrastructure README for Docker setup
Choose the module you want to work on:
| Module | Quick Start Command | Full Setup Guide |
|---|---|---|
| Web | cd web && npm install && npm run dev |
web/README.md |
| API | cd api && pip install -r requirements.txt && uvicorn app.main:app --reload |
api/README.md |
| Mobile | cd mobile && flutter pub get && flutter run |
mobile/README.md |
See each module's README for detailed prerequisites, environment setup, and troubleshooting.
- User authentication (JWT)
- Business card creation (Japanese/English)
- QR code generation
- PDF export (91mm × 55mm)
- Public card sharing
- Basic analytics
- 3-5 professional templates
- More templates (10+ total)
- Advanced analytics dashboard
- vCard export
- User profile management
- OCR card scanner
- Auto-translation (Japanese ↔ English)
- Smart furigana generation
- Team accounts
- iOS app (Flutter)
- Android app (Flutter)
- NFC support
- Camera scanner
Each module has comprehensive test coverage:
| Module | Test Command | Coverage | Full Guide |
|---|---|---|---|
| API | cd api && pytest --cov=app |
90%+ target | api/README.md#testing |
| Web | cd web && npm run test |
85%+ target | web/README.md#testing |
| Mobile | cd mobile && flutter test |
80%+ target | mobile/README.md#testing |
Full testing guides (unit, integration, E2E) in each module's README.
Deployment docs are centralized in infra/README.md.
- Deployment options and step-by-step:
- Deployer assignment for web/api/db:
For detailed information about each component:
| Documentation | Description |
|---|---|
| Web Frontend Guide | Nuxt 4 setup, components, i18n, deployment to Vercel |
| API Backend Guide | FastAPI setup, endpoints, database models, deployment to Vercel |
| Mobile App Guide | Flutter setup, NFC, camera scanner, App Store deployment |
| Infrastructure Guide | Docker, Terraform, CI/CD, monitoring, cost estimation |
See individual module READMEs for specific contribution guidelines.
General workflow:
- Fork the repository
- Create feature branch (
git checkout -b feature/amazing-feature) - Commit changes (
git commit -m 'Add amazing feature') - Push to branch (
git push origin feature/amazing-feature) - Open Pull Request
MIT License - See LICENSE file for details.
Dinakar Maurya
- GitHub: @dinkar1708
If this project helped you, please give it a star!
Built with love for Japanese business culture
