🚗 CoGo - Smart Carpooling Platform

A modern, secure, and user-friendly carpooling platform built with React and Node.js

Features • Demo • Quick Start • Documentation • Contributing

🎯 Demo

Live Application: https://carpooling-app-chl.vercel.app

API Backend: https://backend-kohl-six-71.vercel.app

🚀 The application is deployed on Vercel with separate deployments for frontend and backend.

✨ Features

🔐 Authentication & Security

• Multi-provider Authentication - JWT tokens, Google OAuth integration
• Password Security - Bcrypt hashing with configurable salt rounds
• Rate Limiting - Protection against brute force attacks
• Input Validation - Server-side validation and sanitization
• XSS Protection - Security headers and content security policies

🎨 User Experience

• Modern UI/UX - Intuitive design with Tailwind CSS
• Smooth Animations - Framer Motion for delightful interactions
• Responsive Design - Optimized for all screen sizes (mobile-first)
• Accessibility - WCAG 2.1 AA compliant with ARIA labels
• Dark Mode Ready - Theme support (coming soon)

🚀 Performance & SEO

• Blazing Fast - Code splitting and lazy loading
• Optimized Bundles - Tree shaking and minification
• SEO Optimized - Meta tags, OpenGraph, and structured data
• PWA Support - Service worker and offline capabilities
• CDN Ready - Static assets optimized for edge delivery

🛠️ Tech Stack

🎨 Frontend Technology Purpose React 19 UI library with concurrent features Vite Build tool & dev server Tailwind CSS Utility-first styling Framer Motion Animations & transitions React Router v6 Client-side routing React Hook Form Form management Axios HTTP client with interceptors Sonner Toast notifications Zod Runtime type validation Shadcn/ui Accessible component system

⚙️ Backend Technology Purpose Node.js 18+ JavaScript runtime Express.js Web framework MongoDB NoSQL database Mongoose MongoDB ODM JWT Token-based auth Passport.js Auth strategies Helmet Security headers Express Rate Limit API protection Bcrypt Password hashing Express Validator Input validation

🚀 Quick Start

📋 Prerequisites

Before you begin, ensure you have the following installed:

Requirement	Version	Download
Node.js	18.0.0+	Download
MongoDB	4.4+	Download
Git	Latest	Download
npm/yarn	Latest	Included with Node.js

Installation

1. Clone the repository

git clone https://github.com/your-username/cogo-carpooling.git
cd cogo-carpooling

2. Install root dependencies

npm install

3. Set up Backend

cd backend
npm install

# Create environment file
cp .env.example .env
# Edit .env with your MongoDB URI and other settings

4. Set up Frontend

cd ../frontend
npm install

# Create environment file
cp .env.example .env
# Edit .env with your API URL and other settings

5. Start Development Servers

Backend (Terminal 1):

cd backend
npm run dev

Frontend (Terminal 2):

cd frontend
npm run dev

The application will be available at:

• 🎨 Frontend: http://localhost:5173
• ⚙️ Backend: http://localhost:5000
• 📊 API Docs: http://localhost:5000/api-docs (coming soon)

📁 Project Structure

cogo-carpooling/
├── backend/
│   ├── src/
│   │   ├── config/         # Database and app configuration
│   │   ├── controllers/    # Route handlers
│   │   ├── middleware/     # Custom middleware
│   │   ├── models/         # Database models
│   │   └── routes/         # API routes
│   ├── server.js          # Server entry point
│   └── package.json
├── frontend/
│   ├── public/            # Static assets
│   ├── src/
│   │   ├── components/    # Reusable components
│   │   ├── pages/         # Page components
│   │   ├── services/      # API services
│   │   ├── hooks/         # Custom hooks
│   │   ├── utils/         # Utility functions
│   │   └── assets/        # Images, icons, etc.
│   ├── index.html
│   └── package.json
└── README.md

🔧 Configuration

Environment Variables

Backend (.env)

NODE_ENV=development
PORT=5000
MONGO_URI=mongodb://localhost:27017/cogo
JWT_SECRET=your-super-secret-jwt-key
SESSION_SECRET=your-session-secret
GOOGLE_CLIENT_ID=your-google-client-id
GOOGLE_CLIENT_SECRET=your-google-client-secret
CLIENT_URL=http://localhost:5173

Frontend (.env)

VITE_API_URL=http://localhost:5000/api
VITE_APP_NAME=CoGo
VITE_GOOGLE_CLIENT_ID=your-google-client-id

🧪 Testing

# Backend tests
cd backend
npm test

# Frontend tests
cd frontend
npm test

🏗️ Building for Production

# Build frontend
cd frontend
npm run build

# Build and start backend
cd backend
npm run build
npm start

🚀 Deployment

Docker Deployment

1. Build Docker images

# Backend
cd backend
docker build -t cogo-backend .

# Frontend
cd frontend
docker build -t cogo-frontend .

2. Run with Docker Compose

docker-compose up -d

Manual Deployment

1. Deploy Backend (e.g., on Heroku, Railway, or DigitalOcean)
2. Deploy Frontend (e.g., on Vercel, Netlify, or Cloudflare Pages)
3. Set up MongoDB (MongoDB Atlas recommended)
4. Configure environment variables on your hosting platform

📊 Performance Optimizations

• Code Splitting - Dynamic imports for route-based splitting
• Lazy Loading - Images and components loaded on demand
• Bundle Optimization - Tree shaking and minification
• Caching - Browser caching with proper headers
• CDN Ready - Static assets optimized for CDN delivery

🔒 Security Features

• Input Validation - Server-side validation with express-validator
• Rate Limiting - API rate limiting to prevent abuse
• CORS Configuration - Proper cross-origin resource sharing
• Security Headers - Helmet.js for security headers
• Data Sanitization - Protection against NoSQL injection
• Password Security - Bcrypt hashing with salt rounds

♿ Accessibility Features

• ARIA Labels - Proper labeling for screen readers
• Keyboard Navigation - Full keyboard accessibility
• Focus Management - Proper focus indication and trapping
• Color Contrast - WCAG AA compliant color ratios
• Screen Reader Support - Semantic HTML and proper structure

📱 Progressive Web App

• Service Worker - Offline functionality and caching
• Web App Manifest - App-like experience on mobile
• Push Notifications - Real-time updates (coming soon)
• Install Prompt - Add to home screen functionality

🤝 Contributing

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📄 License

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

🆘 Support

If you encounter any issues or have questions:

1. Check the Issues page
2. Create a new issue with detailed information
3. Contact the development team

🗺️ Roadmap

Phase 1 - Core Features ✅

• User authentication and authorization
• Ride booking system
• Driver registration
• Basic search functionality

Phase 2 - Enhanced Features 🚧

• Real-time chat between riders and drivers
• Push notifications for ride updates
• Advanced search filters
• Ride history and receipts
• Rating and review system

Phase 3 - Advanced Features 📅

• Payment integration (Stripe/PayPal)
• Route optimization with Google Maps
• Admin dashboard with analytics
• Mobile app (React Native)
• Multi-language support (i18n)
• Automated ride matching
• Carbon footprint tracking

👥 Contributors

Thanks to all the amazing people who have contributed to this project!

📞 Contact & Support

• 📧 Email: [email protected]
• 🐛 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions
• 📖 Documentation: Wiki

⭐ Star History

If you find this project useful, please consider giving it a star!

📜 Acknowledgments

• Icons from Lucide Icons
• UI components inspired by Shadcn/ui
• Documentation template from Best-README-Template

---

Built with ❤️ by the CoGo Team

If you like this project, please consider giving it a ⭐!

Back to Top