Skip to content

ryzrr/communityShare

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

5 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐ŸŒฑ CommunityShare - Building Sustainable Communities

License: MIT PRs Welcome Next.js TypeScript

CommunityShare is an open-source platform that solves the real-world problem of resource waste and community disconnection by enabling neighbors to share items, skills, and services locally. Our mission is to promote sustainability, build stronger community bonds, and reduce waste through the power of sharing.

๐ŸŒŸ Features

๐Ÿ  Resource Sharing

  • Item Lending: Share tools, electronics, books, and household items
  • Skill Exchange: Offer tutoring, repairs, consulting, and other services
  • Service Marketplace: Connect neighbors for various tasks and projects
  • Real-time Availability: Live updates on item and service availability

๐Ÿ—บ๏ธ Location-Based Discovery

  • Neighborhood Focus: Find resources within walking distance
  • Smart Matching: AI-powered recommendations based on location and needs
  • Interactive Maps: Visual representation of available resources nearby
  • Distance Filtering: Search by proximity to optimize convenience

๐Ÿ‘ฅ Community Building

  • User Profiles: Build trust through ratings, reviews, and verification
  • Community Events: Organize and discover local gatherings and workshops
  • Volunteer Opportunities: Connect with local causes and initiatives
  • Discussion Forums: Neighborhood-specific communication channels

๐Ÿ“Š Impact Tracking

  • Environmental Metrics: Track waste reduction and carbon footprint savings
  • Community Stats: Monitor sharing activity and community growth
  • Personal Dashboard: Individual impact tracking and achievements
  • Sustainability Goals: Community-wide environmental targets

๐Ÿ”’ Safety & Trust

  • User Verification: Multi-step verification process for safety
  • Rating System: Comprehensive review and rating system
  • Secure Messaging: Built-in chat system for safe communication
  • Community Guidelines: Clear rules and moderation tools

๐Ÿš€ Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn
  • Git

Installation

  1. Clone the repository ```bash git clone https://github.com/yourusername/community-share.git cd community-share ```

  2. Install dependencies ```bash npm install

    or

    yarn install ```

  3. Set up environment variables ```bash cp .env.example .env.local ```

    Fill in your environment variables: ```env NEXT_PUBLIC_APP_URL=http://localhost:3000 DATABASE_URL=your_database_url NEXTAUTH_SECRET=your_nextauth_secret NEXTAUTH_URL=http://localhost:3000 ```

  4. Run the development server ```bash npm run dev

    or

    yarn dev ```

  5. Open your browser Navigate to http://localhost:3000

Database Setup

This project now uses Supabase as its backend database. Prisma is no longer used.

  1. Set up Supabase
    • Create a free account at supabase.com.
    • Create a new project and get your SUPABASE_URL and SUPABASE_ANON_KEY from the project settings.
    • Add these to your .env.local file:
NEXT_PUBLIC_SUPABASE_URL=your-supabase-url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-supabase-anon-key
  1. Configure environment variables Update your .env.local file with your database URL: ```env DATABASE_URL="postgresql://username:password@localhost:5432/communityshare?schema=public" ```

  2. Generate Prisma client and run migrations ```bash npm run db:generate npm run db:push ```

  3. Seed the database with sample data ```bash npm run db:seed ```

  4. View your data (optional) ```bash npm run db:studio ```

๐Ÿ› ๏ธ Tech Stack

  • Frontend: Next.js 15, React 18, TypeScript
  • Styling: Tailwind CSS, shadcn/ui components
  • Database: PostgreSQL with Prisma ORM
  • Authentication: NextAuth.js
  • Real-time: WebSockets for live updates
  • Maps: Mapbox/Google Maps integration
  • Image Storage: Cloudinary/AWS S3
  • Deployment: Vercel/Netlify

๐Ÿ“ Project Structure

``` community-share/ โ”œโ”€โ”€ app/ # Next.js 13+ app directory โ”‚ โ”œโ”€โ”€ (auth)/ # Authentication pages โ”‚ โ”œโ”€โ”€ browse/ # Browse items and services โ”‚ โ”œโ”€โ”€ events/ # Community events โ”‚ โ”œโ”€โ”€ profile/ # User profiles โ”‚ โ””โ”€โ”€ api/ # API routes โ”œโ”€โ”€ components/ # Reusable UI components โ”‚ โ”œโ”€โ”€ ui/ # shadcn/ui components โ”‚ โ”œโ”€โ”€ forms/ # Form components โ”‚ โ””โ”€โ”€ layout/ # Layout components โ”œโ”€โ”€ lib/ # Utility functions โ”œโ”€โ”€ hooks/ # Custom React hooks โ”œโ”€โ”€ types/ # TypeScript type definitions โ”œโ”€โ”€ prisma/ # Database schema and migrations โ””โ”€โ”€ public/ # Static assets ```

๐Ÿค Contributing

We welcome contributions from developers of all skill levels! Here's how you can help:

๐Ÿ› Bug Reports & Feature Requests

  • Check existing issues
  • Create detailed bug reports with reproduction steps
  • Suggest new features that align with our mission

๐Ÿ’ป Code Contributions

  1. Fork the repository
  2. Create a feature branch ```bash git checkout -b feature/amazing-feature ```
  3. Make your changes
  4. Add tests (if applicable)
  5. Commit your changes ```bash git commit -m 'Add some amazing feature' ```
  6. Push to the branch ```bash git push origin feature/amazing-feature ```
  7. Open a Pull Request

๐Ÿ“‹ Contribution Areas

  • Frontend Development: React components, UI/UX improvements
  • Backend Development: API endpoints, database optimization
  • Mobile Development: React Native app (coming soon)
  • DevOps: CI/CD, deployment, monitoring
  • Design: UI/UX design, branding, illustrations
  • Documentation: Technical docs, user guides, translations
  • Testing: Unit tests, integration tests, E2E testing
  • Accessibility: WCAG compliance, screen reader support

๐ŸŽฏ Good First Issues

Look for issues labeled good first issue or help wanted to get started!

๐ŸŒ Real-World Impact

CommunityShare addresses several critical issues:

Environmental Benefits

  • Waste Reduction: Prevents thousands of items from ending up in landfills
  • Carbon Footprint: Reduces manufacturing demand through sharing
  • Resource Efficiency: Maximizes utilization of existing resources

Economic Benefits

  • Cost Savings: Reduces need to purchase rarely-used items
  • Local Economy: Keeps money within local communities
  • Skill Monetization: Enables neighbors to earn from their expertise

Social Benefits

  • Community Connection: Strengthens neighborhood relationships
  • Social Inclusion: Provides access to resources regardless of economic status
  • Knowledge Sharing: Facilitates learning and skill development

๐Ÿ—บ๏ธ Roadmap

Phase 1: Core Platform โœ…

  • Basic sharing functionality
  • User authentication and profiles
  • Location-based search
  • Rating and review system

Phase 2: Community Features ๐Ÿšง

  • Community events
  • Volunteer opportunities
  • Discussion forums
  • Group messaging

Phase 3: Advanced Features ๐Ÿ“‹

  • Mobile app (React Native)
  • AI-powered recommendations
  • Integration with local businesses
  • Multi-language support

Phase 4: Scale & Impact ๐Ÿ”ฎ

  • City-wide partnerships
  • Impact measurement dashboard
  • API for third-party integrations
  • Franchise/white-label options

๐Ÿ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

๐Ÿ™ Acknowledgments

  • Contributors: Thank you to all our amazing contributors!
  • Community: Grateful for our active user community
  • Sponsors: Special thanks to our project sponsors
  • Open Source: Built on the shoulders of giants in the open source community

Made with โค๏ธ by the community, for the community.

Together, we're building a more sustainable and connected world, one neighborhood at a time.

About

working on it .... pushing soon

Resources

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors