Why the Name "Vizinn"?
The name Vizinn is a stylized nod to the Portuguese word "vizinho", which means neighbor. It's inspired by how the word is commonly pronounced in the Northeast region of Brazil, where local dialects often soften or simplify the ending to sound more like "vizin" or "vizinn".
Vizinn is an innovative, open-source platform that connects users in specific regions for buying, selling, and offering services in a practical and secure way. Our goal is to strengthen the local economy and create a reliable environment for transactions between neighbors and nearby communities.
We welcome contributors from all backgrounds. Whether you're a seasoned developer or just starting out, this project offers a fantastic opportunity to collaborate and make a real impact.
Why Join Vizinn?
- 📚 Learn modern technologies in a real-world application
- 👥 Collaborate with a community of developers
- 📝 Build a meaningful addition to your professional portfolio
- 🌐 Make an impact on local communities through technology
We believe in transparent, collaborative development and look forward to your contributions!
👉 For a detailed contribution guide, check out our CONTRIBUTING guide.
See or create an issue!
Join us on 👾 Discord. If you wish to support this initiative or be part of the project, contact us:
🔗 Link
💼 Market Impact
🌱 Economic Impact
- Stimulate Local Commerce: Reduce economic leakage by keeping transactions within communities
- Empower Small Entrepreneurs: Lower barriers to entry for micro-entrepreneurs and service providers
- Reduce Transport Costs: Minimize logistics expenses by facilitating hyperlocal transactions
- Create New Market Opportunities: Enable service providers to reach customers in their immediate vicinity
👥 Social Impact
- Strengthen Community Bonds: Foster connections between neighbors
- Increase Safety and Trust: Verified marketplace with accountability through a rating system
- Reduce Environmental Footprint: Encourage local consumption and decrease emissions
- Bridge Digital Divide: Provide access to local markets for all community members
🚀 Innovation Potential
- Data-Driven Insights: Generate valuable data about local commerce
- Scalable: Adaptable from condominiums to university campuses
- Integration with Local Services: Delivery networks and payment systems
- Community-Led Development: Features evolve from community needs
🎯 Initial Focus
Users define their area of interest, enabling transactions within their condominium or locations like universities, malls, and neighborhoods.
📌 Main Features
- ✅ Exclusive Marketplace — Buy/sell in nearby regions
- 🌟 Featured Listings — Paid highlights for increased visibility
- 📍 Smart Location Filters — Filter by condo or region
- 🔄 Exchange and Donation Area — Promote circular economy
- 🏢 Building Manager Panel — Announcements and events
- ⭐ Ratings and Reputation — Feedback system
- 🔒 Security and Moderation — Identity verification and reports
- 💳 Integrated Payment Option — Secure in-app payments
- 📢 Specific Requests — E.g., “I want lunch at UFRN”
🛠 Technologies Used
Front-End (TypeScript)
- ⚛ React Native
- 📱 Expo
- 🚀 Ignite
- 🎨 NativeWind (TailwindCSS)
- 🔗 Axios
- 📲 React Navigation
Back-End (Python)
- ⚡ FastAPI
- 🗄 SQLAlchemy
- 🔐 JWT
- 🏦 SQLite/PostgreSQL
- 🔧 Alembic
- 📊 Pydantic
Others
- 🔔 WebSockets
- 🚀 CI/CD
- 📦 PNPM
- 🐍 Poetry
🗂 Monorepo Structure
-
packages/backend: Python API (FastAPI) -
packages/frontend-app: Mobile App (React Native) -
packages/shared-ui: Shared UI utilities
🤝 Contributing
Why Contribute?
- Gain experience with modern tech stack
- Build your portfolio
- Connect with developers
- Learn collaborative workflows
- Make a local impact
Workflow
# Fork & Clone
git clone https://github.com/YOUR-USERNAME/vizinn-app.git
cd vizinn
# Setup & Branch
pnpm install
git checkout -b feature-name
# Commit & Push
git commit -m "Add feature: description"
git push origin feature-name
# Open a PR to main repo
Guidelines
- Check issues/PRs before starting
- Follow code style
- Write clear commits
- Include tests and docs
- Keep PRs focused
Contributor Perks
- 🎖 Role on Discord
- 🧾 Name on contributors list
- 💼 Opportunity to become a maintainer
🧰 Requirements
- Node.js >= 18.0.0
- pnpm >= 8.0.0
- Python >= 3.13
- Poetry
📚 Learning Resources
React Native & Expo
FastAPI & Python
Monorepo & pnpm
Development Workflows
🚀 Recent Updates (14/05)
- Added comprehensive backend documentation
- Improved monorepo structure and package management
- Added Poetry configuration for Python dependency management
- Enhanced script commands for better development experience
- Updated monorepo package.json metadata
- Added Python 3.13 requirement
Let’s build a better neighborhood together 🚀
Nice, bro!